com.haulmont.cuba.gui.components

Class ComponentGenerationContext

java.lang.Object

com.haulmont.cuba.gui.components.ComponentGenerationContext

public class ComponentGenerationContext
extends java.lang.Object

A class which stores information that can be used when creating a component by the ComponentsFactory.

Constructor Summary

Constructors

Constructor and Description
ComponentGenerationContext(MetaClass metaClass, java.lang.String property) Creates an instance of ComponentGenerationContext.

Method Summary

Modifier and Type	Method and Description
java.lang.Class	getComponentClass()
Datasource	getDatasource()
MetaClass	getMetaClass()
CollectionDatasource	getOptionsDatasource()
java.lang.String	getProperty()
org.dom4j.Element	getXmlDescriptor()
ComponentGenerationContext	setComponentClass(java.lang.Class componentClass) Sets a component class for which a component is created, using fluent API method.
ComponentGenerationContext	setDatasource(Datasource datasource) Sets a datasource, using fluent API method.
ComponentGenerationContext	setMetaClass(MetaClass metaClass) Sets the entity for which the component is created, using fluent API method.
ComponentGenerationContext	setOptionsDatasource(CollectionDatasource optionsDatasource) Sets a datasource that can be used to show options, using fluent API method.
ComponentGenerationContext	setProperty(java.lang.String property) Sets the entity attribute for which the component is created, using fluent API method.
ComponentGenerationContext	setXmlDescriptor(org.dom4j.Element xmlDescriptor) Sets an XML descriptor which contains additional information, using fluent API method.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentGenerationContext

public ComponentGenerationContext(MetaClass metaClass,
                                  java.lang.String property)

Creates an instance of ComponentGenerationContext.

Parameters:

metaClass - the entity for which the component is created

property - the entity attribute for which the component is created

Method Detail

getMetaClass

public MetaClass getMetaClass()

Returns:

the entity for which the component is created

setMetaClass

public ComponentGenerationContext setMetaClass(MetaClass metaClass)

Sets the entity for which the component is created, using fluent API method.

Parameters:

metaClass - the entity for which the component is created

Returns:

this object

getProperty

public java.lang.String getProperty()

Returns:

the entity attribute for which the component is created

setProperty

public ComponentGenerationContext setProperty(java.lang.String property)

Sets the entity attribute for which the component is created, using fluent API method.

Parameters:

property - the entity attribute for which the component is created

Returns:

this object

getDatasource

@Nullable
public Datasource getDatasource()

Returns:

a datasource that can be used to create the component

setDatasource

public ComponentGenerationContext setDatasource(Datasource datasource)

Sets a datasource, using fluent API method.

Parameters:

datasource - a datasource

Returns:

this object

getOptionsDatasource

@Nullable
public CollectionDatasource getOptionsDatasource()

Returns:

a datasource that can be used to show options

setOptionsDatasource

public ComponentGenerationContext setOptionsDatasource(CollectionDatasource optionsDatasource)

Sets a datasource that can be used to show options, using fluent API method.

Parameters:

optionsDatasource - a datasource that can be used as optional to create the component

Returns:

this object

getXmlDescriptor

@Nullable
public org.dom4j.Element getXmlDescriptor()

Returns:

an XML descriptor which contains additional information

setXmlDescriptor

public ComponentGenerationContext setXmlDescriptor(org.dom4j.Element xmlDescriptor)

Sets an XML descriptor which contains additional information, using fluent API method.

Parameters:

xmlDescriptor - an XML descriptor which contains additional information

Returns:

this object

getComponentClass

@Nullable
public java.lang.Class getComponentClass()

Returns:

a component class for which a component is created

setComponentClass

public ComponentGenerationContext setComponentClass(java.lang.Class componentClass)

Sets a component class for which a component is created, using fluent API method.

Parameters:

componentClass - a component class for which a component is created

Returns:

this object