com.vaadin.generator.metadata

Class ComponentEventData

java.lang.Object

com.vaadin.generator.metadata.ComponentEventData

public class ComponentEventData
extends Object

Represents an event the webcomponent can trigger.

Since:

1.0

See Also:

ComponentMetadata

Constructor Summary

Constructors

Constructor and Description
ComponentEventData()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Gets the public description of the event, that can be used to generate the corresponding Javadoc at the Java class.
String	getName() Gets the name of the event, such as "click".
List<ComponentPropertyBaseData>	getProperties() Gets the list of properties that are part of the event.
void	setDescription(String description) Sets the public description of the event, that can be used to generate the corresponding Javadoc at the Java class.
void	setName(String name) Sets the name of the event, such as "click".
void	setProperties(List<ComponentPropertyBaseData> properties) Sets the list of properties that are part of the event.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentEventData

public ComponentEventData()

Method Detail

getName

public String getName()

Gets the name of the event, such as "click".

Returns:

The name of the event.

setName

public void setName(String name)

Sets the name of the event, such as "click".

Parameters:

name - The name of the event.

getDescription

public String getDescription()

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

Returns:

The event-level description.

setDescription

public void setDescription(String description)

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

Parameters:

description - The event-level description.

getProperties

public List<ComponentPropertyBaseData> getProperties()

Gets the list of properties that are part of the event. Each property is represented by the ComponentPropertyBaseData object.

Returns:

The list of properties that are part of the event.

setProperties

public void setProperties(List<ComponentPropertyBaseData> properties)

Sets the list of properties that are part of the event. Each property is represented by the ComponentPropertyBaseData object.

Parameters:

properties - The list of properties that are part of the event.