io.jmix.ui.component

Class ComponentGenerationContext

java.lang.Object

io.jmix.ui.component.ComponentGenerationContext

Direct Known Subclasses:

JpqlFilterComponentGenerationContext, PropertyFilterComponentGenerationContext

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 io.jmix.core.metamodel.model.MetaClass	metaClass
protected Options	options
protected java.lang.String	property
protected java.lang.Class<?>	targetClass
protected ValueSource	valueSource
protected org.dom4j.Element	xmlDescriptor

Constructor Summary

Constructors

Constructor and Description
ComponentGenerationContext(io.jmix.core.metamodel.model.MetaClass metaClass, java.lang.String property) Creates an instance of ComponentGenerationContext.

Method Summary

Modifier and Type	Method and Description
io.jmix.core.metamodel.model.MetaClass	getMetaClass()
Options	getOptions()
java.lang.String	getProperty()
java.lang.Class<?>	getTargetClass()
ValueSource	getValueSource()
org.dom4j.Element	getXmlDescriptor()
ComponentGenerationContext	setOptions(Options options) Sets an options object, using fluent API method.
ComponentGenerationContext	setTargetClass(java.lang.Class<?> targetClass) Sets a target class for which a 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 final io.jmix.core.metamodel.model.MetaClass metaClass

property

protected final java.lang.String property

valueSource

protected ValueSource valueSource

options

protected Options options

xmlDescriptor

protected org.dom4j.Element xmlDescriptor

targetClass

protected java.lang.Class<?> targetClass

Constructor Detail

ComponentGenerationContext

public ComponentGenerationContext(io.jmix.core.metamodel.model.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 io.jmix.core.metamodel.model.MetaClass getMetaClass()

Returns:

the entity for which the component is created

getProperty

public java.lang.String getProperty()

Returns:

the entity attribute for which the component is created

getValueSource

@Nullable
public ValueSource getValueSource()

Returns:

a value source that can be used to create the component

setValueSource

public ComponentGenerationContext setValueSource(@Nullable
                                                 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(@Nullable
                                             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(@Nullable
                                                   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

getTargetClass

@Nullable
public java.lang.Class<?> getTargetClass()

Returns:

a target class for which a component is created

setTargetClass

public ComponentGenerationContext setTargetClass(@Nullable
                                                 java.lang.Class<?> targetClass)

Sets a target class for which a component is created, using fluent API method. For instance, a target class can be a component or a screen.

Parameters:

targetClass - a target class for which a component is created

Returns:

this object