com.vaadin.generator.metadata

Class ComponentPropertyBaseData

java.lang.Object

com.vaadin.generator.metadata.ComponentPropertyBaseData

Direct Known Subclasses:

ComponentFunctionParameterData, ComponentPropertyData

public class ComponentPropertyBaseData
extends Object

Base class of properties exposed by the webcomponent, that can be properties themselves, event properties or function parameters.

Since:

1.0

See Also:

ComponentMetadata

Constructor Summary

Constructors

Constructor and Description
ComponentPropertyBaseData()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Gets the public description of the function parameter, that can be used to generate the corresponding Javadoc at the Java class.
String	getName() Gets the name of the property.
List<ComponentObjectType>	getObjectType() Gets the object type properties.
Set<ComponentBasicType>	getType() Gets the type of the property, or if property allows varying types, a list of those.
void	setDescription(String description) Sets the public description of the function parameter, that can be used to generate the corresponding Javadoc at the Java class.
void	setName(String name) Sets the name of the property.
void	setObjectType(List<ComponentObjectType> objectType) Sets the object type properties.
void	setType(Set<ComponentBasicType> type) Sets the type of the property, or if property allows varying types, a list of those.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentPropertyBaseData

public ComponentPropertyBaseData()

Method Detail

getObjectType

public List<ComponentObjectType> getObjectType()

Gets the object type properties.

Returns:

a list of the object type properties

setObjectType

public void setObjectType(List<ComponentObjectType> objectType)

Sets the object type properties.

Parameters:

objectType - the

getName

public String getName()

Gets the name of the property.

Returns:

the name The name of the property.

setName

public void setName(String name)

Sets the name of the property.

Parameters:

name - The name of the property.

getType

public Set<ComponentBasicType> getType()

Gets the type of the property, or if property allows varying types, a list of those.

Returns:

the type the type in a list or the a list of allowed types

setType

public void setType(Set<ComponentBasicType> type)

Sets the type of the property, or if property allows varying types, a list of those.

Parameters:

type - The type of the property in a list or a list of allowed types

getDescription

public String getDescription()

Gets the public description of the function parameter, that can be used to generate the corresponding Javadoc at the Java class.

Returns:

The function parameter description.

setDescription

public void setDescription(String description)

Sets the public description of the function parameter, that can be used to generate the corresponding Javadoc at the Java class.

Parameters:

description - The function parameter description.