com.haulmont.cuba.gui.components

Class ComponentGenerationContext

java.lang.Object

com.haulmont.cuba.gui.components.ComponentGenerationContext

public class ComponentGenerationContext
extends java.lang.Object

Contains information for ComponentGenerationStrategy when creating components using UiComponentsGenerator.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Class	componentClass
protected Datasource	datasource Deprecated.
protected MetaClass	metaClass
protected Options	options
protected CollectionDatasource	optionsDatasource Deprecated.
protected java.lang.String	property
protected ValueSource	valueSource
protected org.dom4j.Element	xmlDescriptor

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() Deprecated. Use getValueSource() instead
MetaClass	getMetaClass()
Options	getOptions()
CollectionDatasource	getOptionsDatasource() Deprecated. Use getOptions() instead
java.lang.String	getProperty()
ValueSource	getValueSource()
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) Deprecated. Use setValueSource(ValueSource) instead
ComponentGenerationContext	setMetaClass(MetaClass metaClass) Sets the entity for which the component is created, using fluent API method.
ComponentGenerationContext	setOptions(Options options) Sets an options object, using fluent API method.
ComponentGenerationContext	setOptionsDatasource(CollectionDatasource optionsDatasource) Deprecated. Use setOptions(Options) instead
ComponentGenerationContext	setProperty(java.lang.String property) Sets the entity attribute for which the component is created, using fluent API method.
ComponentGenerationContext	setValueSource(ValueSource valueSource) Sets a value source, 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

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

Field Detail

metaClass

protected MetaClass metaClass

property

protected java.lang.String property

datasource

@Deprecated
protected Datasource datasource

Deprecated.

optionsDatasource

@Deprecated
protected CollectionDatasource optionsDatasource

Deprecated.

valueSource

protected ValueSource valueSource

options

protected Options options

xmlDescriptor

protected org.dom4j.Element xmlDescriptor

componentClass

protected java.lang.Class componentClass

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

@Deprecated
 @Nullable
public Datasource getDatasource()

Deprecated. Use getValueSource() instead

Returns:

a datasource that can be used to create the component

setDatasource

@Deprecated
public ComponentGenerationContext setDatasource(Datasource datasource)

Deprecated. Use setValueSource(ValueSource) instead

Sets a datasource, using fluent API method.

Parameters:

datasource - a datasource

Returns:

this object

getOptionsDatasource

@Deprecated
 @Nullable
public CollectionDatasource getOptionsDatasource()

Deprecated. Use getOptions() instead

Returns:

a datasource that can be used to show options

setOptionsDatasource

@Deprecated
public ComponentGenerationContext setOptionsDatasource(CollectionDatasource optionsDatasource)

Deprecated. Use setOptions(Options) instead

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

getValueSource

@Nullable
public ValueSource getValueSource()

Returns:

a value source that can be used to create the component

setValueSource

public ComponentGenerationContext setValueSource(ValueSource valueSource)

Sets a value source, using fluent API method.

Parameters:

valueSource - a value source to set

Returns:

this object

getOptions

@Nullable
public Options getOptions()

Returns:

an options object

setOptions

public ComponentGenerationContext setOptions(Options options)

Sets an options object, using fluent API method.

Parameters:

options - an options object 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