Package io.github.jeemv.springboot.vuejs.components

Class VueComponent

java.lang.Object

io.github.jeemv.springboot.vuejs.AbstractVueJS

io.github.jeemv.springboot.vuejs.components.VueComponent

public class VueComponent
extends AbstractVueJS

VueJS component class This class is part of springBoot-VueJS Components are created in src/main/resources/static/

Field Summary

Fields inherited from class io.github.jeemv.springboot.vuejs.AbstractVueJS

computed, data, directives, filters, hooks, methods, watchers

Constructor Summary

Constructors

Constructor	Description
VueComponent()
VueComponent(String name)
VueComponent(String name, boolean internal)

Method Summary

Modifier and Type	Method	Description
VueProp	addProp(String name, Object defaultValue)	Adds a new property to the component
VueProp	addProp(String name, String type, boolean required)	Adds a required property to the component
VueProp	addProp(String name, String type, boolean required, boolean mutable)	Adds a mutable property (use mutProperty=value to assign a value)
VueProp	addPropRaw(String name, String defaultValue)	Adds a new property to the component defaultValue is not quoted (because it's a raw property)
void	createFile(boolean minify)
void	createFile(String pathFilename, boolean minify)	Generates a new VueJS component and save it to a file
String	getName()
VueProps	getProps()
String	getScript()	Returns the generated script creating the instance
String	getTemplate()
static void	globalJs()
static void	globalJs(String... files)
boolean	isInternal()
protected void	loadTemplateFile(String filename)
VueComponent	setDefaultTemplateFile()	Sets the default template file (componentName+".html")
void	setInternal(boolean internal)	Defines if the component is created in the vue instance or not
VueComponent	setProps(String... props)	Sets the component properties
VueComponent	setTemplate(String template)	Defines the template string
VueComponent	setTemplateFile(String pathFilename)	Sets a template file

Methods inherited from class io.github.jeemv.springboot.vuejs.AbstractVueJS

addComputed, addComputed, addData, addData, addDataRaw, addDeepWatcher, addDirective, addDirective, addFilter, addHook, addImmediateWatcher, addMethod, addMethod, addMethod, addWatcher, addWatcher, addWatcher, assignOriginal, assignOriginalWithHttp, attachDeepWatcher, attachImmediateWatcher, attachWatcher, attachWatcher, attachWatcher, cloneOriginalData, get, getComputed, getData, getDirectives, getFilters, getHooks, getMethods, getWatchers, onBeforeCreate, onBeforeDestroy, onBeforeMount, onBeforeUpdate, onCreated, onDestroyed, onMounted, onUpdated, onUpdatedNextTick, set, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

VueComponent

public VueComponent()

VueComponent

public VueComponent(String name)

VueComponent

public VueComponent(String name,
 boolean internal)

Method Details

getScript

public String getScript()

Description copied from class: AbstractVueJS

Returns the generated script creating the instance

Specified by:

getScript in class AbstractVueJS

Returns:

the generated script (javascript)

getName

public String getName()

getTemplate

public String getTemplate()

setTemplate

public VueComponent setTemplate(String template)

Defines the template string

Parameters:

template -

Returns:

VueComponent

setTemplateFile

public VueComponent setTemplateFile(String pathFilename)

Sets a template file

Parameters:

pathFilename -

Returns:

VueComponent

setDefaultTemplateFile

public VueComponent setDefaultTemplateFile()

Sets the default template file (componentName+".html")

isInternal

public boolean isInternal()

setInternal

public void setInternal(boolean internal)

Defines if the component is created in the vue instance or not

Parameters:

internal -

getProps

public VueProps getProps()

setProps

public VueComponent setProps(String... props)

Sets the component properties

Parameters:

props -

Returns:

VueComponent

addProp

public VueProp addProp(String name,
 Object defaultValue)

Adds a new property to the component

Parameters:

name - The property name

defaultValue - The property default value

Returns:

addPropRaw

public VueProp addPropRaw(String name,
 String defaultValue)

Adds a new property to the component defaultValue is not quoted (because it's a raw property)

Parameters:

name - The property name

defaultValue - non quoted value

Returns:

addProp

public VueProp addProp(String name,
 String type,
 boolean required)

Adds a required property to the component

Parameters:

name - The property name

type - The property type

required - true if the property is required

Returns:

addProp

public VueProp addProp(String name,
 String type,
 boolean required,
 boolean mutable)

Adds a mutable property (use mutProperty=value to assign a value)

Parameters:

name - then name of the property

type - the property type (Object,Array,Function,String,Number,Boolean)

required - if true property is required

mutable - if true property is mutable

Returns:

the property added

loadTemplateFile

protected void loadTemplateFile(String filename)
                         throws IOException

Throws:

IOException

createFile

public void createFile(String pathFilename,
 boolean minify)
                throws IOException

Generates a new VueJS component and save it to a file

Parameters:

pathFilename - the path file name (from static folder)

minify - if true minify the javascript source code

Throws:

IOException - for file creation

createFile

public void createFile(boolean minify)
                throws IOException

Throws:

IOException

globalJs

public static void globalJs()

globalJs

public static void globalJs(String... files)
                     throws IOException

Throws:

IOException