com.haulmont.cuba.gui.components

Interface FieldGroup.FieldConfig

All Superinterfaces:

Component.HasCaption, Component.HasFormatter, Component.HasInputPrompt, Component.HasXmlDescriptor

Enclosing interface:

FieldGroup

public static interface FieldGroup.FieldConfig
extends Component.HasXmlDescriptor, Component.HasCaption, Component.HasFormatter, Component.HasInputPrompt

Configuration of a field. Used as declarative configuration object. After component is set it can be used as Field API for a Component that does not implement Field.

Method Summary

Modifier and Type	Method and Description
void	addValidator(Field.Validator validator) Add validator for declarative field.
Component	getComponent()
Component	getComponentNN()
java.util.function.Consumer<Component.ContextHelpIconClickEvent>	getContextHelpIconClickHandler()
java.lang.String	getContextHelpText()
Datasource	getDatasource()
java.lang.String	getId()
CollectionDatasource	getOptionsDatasource()
java.lang.String	getProperty()
java.lang.String	getRequiredError() Deprecated. Use getRequiredMessage()
java.lang.String	getRequiredMessage()
java.lang.String	getStyleName()
java.lang.Integer	getTabIndex()
Datasource	getTargetDatasource()
java.lang.String	getWidth()
boolean	isBound()
java.lang.Boolean	isContextHelpTextHtmlEnabled()
boolean	isCustom()
java.lang.Boolean	isEditable()
java.lang.Boolean	isEnabled()
java.lang.Boolean	isRequired()
java.lang.Boolean	isVisible()
void	removeValidator(Field.Validator validator) Remove validator.
void	setComponent(Component component) Bind Component to this field config.
void	setComponent(Component component, FieldGroup.FieldAttachMode mode) Bind Component to this field config.
void	setContextHelpIconClickHandler(java.util.function.Consumer<Component.ContextHelpIconClickEvent> handler) Sets a context help icon click handler
void	setContextHelpText(java.lang.String contextHelpText) Set context help text for declarative field.
void	setContextHelpTextHtmlEnabled(java.lang.Boolean enabled) Defines if context help text can be presented as HTML.
void	setCustom(boolean custom) Set custom flag.
void	setDatasource(Datasource datasource) Set datasource for declarative field.
void	setEditable(java.lang.Boolean editable) Set editable for declarative field.
void	setEnabled(java.lang.Boolean enabled) Set enabled for declarative field.
void	setOptionsDatasource(CollectionDatasource optionsDatasource) Set options datasource for declarative field.
void	setProperty(java.lang.String property) Set property for declarative field.
void	setRequired(java.lang.Boolean required) Set required for declarative field.
void	setRequiredError(java.lang.String requiredError) Deprecated. Use setRequiredMessage(String)}
void	setRequiredMessage(java.lang.String requiredMessage) Set required message for declarative field.
void	setStyleName(java.lang.String stylename) Set stylename parameter.
void	setTabIndex(java.lang.Integer tabIndex) Set tab index for declarative field.
void	setVisible(java.lang.Boolean visible) Set visible for declarative field.
void	setWidth(java.lang.String width) Set width parameter.

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasXmlDescriptor

getXmlDescriptor, setXmlDescriptor

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, getDescription, setCaption, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasFormatter

getFormatter, setFormatter

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasInputPrompt

getInputPrompt, setInputPrompt

Method Detail

getId

java.lang.String getId()

Returns:

id

isBound

boolean isBound()

Returns:

true if this field config is connected to the concrete component and cannot be reconfigured.

getWidth

java.lang.String getWidth()

Returns:

width

setWidth

void setWidth(java.lang.String width)

Set width parameter.
If isBound() is true sets width to the connected Component.

Parameters:

width - width

getStyleName

java.lang.String getStyleName()

Returns:

style name

setStyleName

void setStyleName(java.lang.String stylename)

Set stylename parameter.
If isBound() is true sets stylename to the connected Component.

Parameters:

stylename - style name

getTargetDatasource

Datasource getTargetDatasource()

Returns:

own datasource of a field or datasource of the parent FieldGroup

getDatasource

Datasource getDatasource()

Returns:

datasource

setDatasource

void setDatasource(Datasource datasource)

Set datasource for declarative field.
Throws exception if FieldConfig is already connected to Component.

Parameters:

datasource - datasource

isRequired

java.lang.Boolean isRequired()

Returns:

true if field is required, null if not set for declarative field

setRequired

void setRequired(java.lang.Boolean required)

Set required for declarative field.
If isBound() is true and Component implements Field then sets required to the connected Component.

Parameters:

required - required flag

isEditable

java.lang.Boolean isEditable()

Returns:

true if field is editable, null if not set for declarative field

setEditable

void setEditable(java.lang.Boolean editable)

Set editable for declarative field.
If isBound() is true and Component implements Field then sets editable to the connected Component.

Parameters:

editable - editable flag

isEnabled

java.lang.Boolean isEnabled()

Returns:

true if field is enabled, null if not set for declarative field

setEnabled

void setEnabled(java.lang.Boolean enabled)

Set enabled for declarative field.
If isBound() is true then sets enabled to the connected Component.

Parameters:

enabled - enabled flag

isVisible

java.lang.Boolean isVisible()

Returns:

true if field is visible, null if not set for declarative field

setVisible

void setVisible(java.lang.Boolean visible)

Set visible for declarative field.
If isBound() is true then sets visible to the connected Component.

Parameters:

visible - visible flag

getProperty

java.lang.String getProperty()

Returns:

property name

setProperty

void setProperty(java.lang.String property)

Set property for declarative field.
Throws exception if FieldConfig is already connected to Component.

Parameters:

property - property name

getTabIndex

java.lang.Integer getTabIndex()

Returns:

tab index

setTabIndex

void setTabIndex(java.lang.Integer tabIndex)

Set tab index for declarative field.
If isBound() is true and Component implements Focusable then sets tab index to the connected Component.

Parameters:

tabIndex - tab index

getRequiredError

@Deprecated
java.lang.String getRequiredError()

Deprecated. Use getRequiredMessage()

Returns:

required message

setRequiredError

@Deprecated
void setRequiredError(java.lang.String requiredError)

Deprecated. Use setRequiredMessage(String)}

isCustom

boolean isCustom()

Returns:

true if field is marked as custom

setCustom

void setCustom(boolean custom)

Set custom flag.
If field is marked as custom then FieldGroup.bind() will not create Component for field even if it does not have connected Component.

Parameters:

custom - custom flag

getRequiredMessage

java.lang.String getRequiredMessage()

Returns:

required message

setRequiredMessage

void setRequiredMessage(java.lang.String requiredMessage)

Set required message for declarative field.
If isBound() is true and Component implements Field then sets required message to the connected Component.

Parameters:

requiredMessage - required message

getComponent

@Nullable
Component getComponent()

Returns:

bound component

getComponentNN

Component getComponentNN()

Returns:

bound component. Throws exception if component is null.

setComponent

void setComponent(Component component)

Bind Component to this field config. Component cannot be changed if it is assigned.
FieldConfig will apply default values for caption, description, width, required and other Field properties.

When used with custom="true", the datasource and the property should be set up manually.

Parameters:

component - component

See Also:

FieldConfig#setComponent(Component, FieldAttachMode)

setComponent

void setComponent(Component component,
                  FieldGroup.FieldAttachMode mode)

Bind Component to this field config. Component cannot be changed if it is assigned.
If mode is FieldGroup.FieldAttachMode.APPLY_DEFAULTS then FieldConfig will apply default values for caption, description, width, required and other Field properties otherwise it will not.

When used with custom="true", the datasource and the property should be set up manually.

Parameters:

component - component

mode - field attach mode

addValidator

void addValidator(Field.Validator validator)

Add validator for declarative field.
If field is bound to Component and Component implements Field then validator will be added to Component directly.

Parameters:

validator - validator

removeValidator

void removeValidator(Field.Validator validator)

Remove validator.
If field is bound to Component and Component implements Field then validator will be removed from Component directly.

Parameters:

validator - validator

setOptionsDatasource

void setOptionsDatasource(CollectionDatasource optionsDatasource)

Set options datasource for declarative field.
If field is bound to Component and Component implements OptionsField then optionsDatasource will be set to Component directly.

Parameters:

optionsDatasource - options datasource

getOptionsDatasource

CollectionDatasource getOptionsDatasource()

Returns:

options datasource

getContextHelpText

java.lang.String getContextHelpText()

Returns:

context help text

setContextHelpText

void setContextHelpText(java.lang.String contextHelpText)

Set context help text for declarative field. If isBound() is true and Component implements Field then sets context help text to the connected Component.

Parameters:

contextHelpText - context help text to be set

isContextHelpTextHtmlEnabled

java.lang.Boolean isContextHelpTextHtmlEnabled()

Returns:

true if field accepts context help text in HTML format, null if not set for a declarative field

setContextHelpTextHtmlEnabled

void setContextHelpTextHtmlEnabled(java.lang.Boolean enabled)

Defines if context help text can be presented as HTML.

If isBound() is true and Component implements Field then sets this attribute to the connected Component.

Parameters:

enabled - true if field accepts context help text in HTML format

getContextHelpIconClickHandler

java.util.function.Consumer<Component.ContextHelpIconClickEvent> getContextHelpIconClickHandler()

Returns:

a context help icon click handler

setContextHelpIconClickHandler

void setContextHelpIconClickHandler(java.util.function.Consumer<Component.ContextHelpIconClickEvent> handler)

Sets a context help icon click handler

Parameters:

handler - the handler to set