com.haulmont.cuba.gui.components

Interface FieldGroup

All Superinterfaces:

ChildEditableController, Component, Component.BelongToFrame, Component.Editable, Component.HasCaption, Component.HasDescription, Component.HasIcon, ComponentContainer, EditableChangeNotifier, HasBorder, HasContextHelp, HasSubParts, Validatable

public interface FieldGroup
extends Component, Component.BelongToFrame, Component.HasCaption, Component.HasIcon, HasBorder, HasContextHelp, Component.Editable, Validatable, EditableChangeNotifier, ChildEditableController, ComponentContainer, HasSubParts

Multi-column form component.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FieldGroup.CustomFieldGenerator Deprecated. Set component implementation directly to FieldGroup.FieldConfig using FieldGroup.FieldConfig.setComponent(Component) method.
static class	FieldGroup.FieldAttachMode Whether apply declarative defaults for custom field or not.
static class	FieldGroup.FieldCaptionAlignment Field caption alignment.
static interface	FieldGroup.FieldConfig Configuration of a field.
static class	FieldGroup.FieldsValidationException Exception that is thrown from validate().

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.EditableChangeNotifier

EditableChangeNotifier.EditableChangeEvent

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider, Component.Wrapper

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
void	addCustomField(FieldGroup.FieldConfig field, FieldGroup.CustomFieldGenerator fieldGenerator) Deprecated. Set Component implementation directly to FieldGroup.FieldConfig using FieldGroup.FieldConfig.setComponent(Component) method.
void	addCustomField(java.lang.String fieldId, FieldGroup.CustomFieldGenerator fieldGenerator) Deprecated. Set Component implementation directly to FieldGroup.FieldConfig using FieldGroup.FieldConfig.setComponent(Component) method.
void	addField(FieldGroup.FieldConfig field) Append field to 1 column.
void	addField(FieldGroup.FieldConfig fieldConfig, int colIndex) Append field to colIndex column.
void	addField(FieldGroup.FieldConfig fieldConfig, int colIndex, int rowIndex) Insert field to colIndex column to rowIndex position.
default void	addValidator(FieldGroup.FieldConfig field, Field.Validator validator) Deprecated. Use FieldConfig.addValidator(validator) instead.
default void	addValidator(java.lang.String fieldId, Field.Validator validator) Deprecated. Use FieldGroup.getFieldNN(fieldId).addValidator(validator) instead.
void	bind() Create and bind components for all declarative fields.
FieldGroup.FieldConfig	createField(java.lang.String id) Create new field config.
void	focusField(java.lang.String fieldId) Request focus on field.
void	focusFirstField() Focus the first enabled, visible and editable field.
FieldGroup.FieldCaptionAlignment	getCaptionAlignment()
float	getColumnExpandRatio(int colIndex)
int	getColumns()
Datasource	getDatasource()
FieldGroup.FieldConfig	getField(int column, int row)
FieldGroup.FieldConfig	getField(java.lang.String fieldId) Get field config by id.
default java.lang.String	getFieldCaption(java.lang.String fieldId) Deprecated. Use FieldGroup.getFieldNN(fieldId).getCaption() instead.
int	getFieldCaptionWidth()
int	getFieldCaptionWidth(int colIndex)
default Component	getFieldComponent(FieldGroup.FieldConfig fieldConfig) Deprecated.
default Component	getFieldComponent(java.lang.String id) Deprecated.
FieldGroupFieldFactory	getFieldFactory()
FieldGroup.FieldConfig	getFieldNN(java.lang.String fieldId) Get field config by id.
java.util.List<FieldGroup.FieldConfig>	getFields()
java.util.List<FieldGroup.FieldConfig>	getFields(int column)
default java.lang.Object	getFieldValue(FieldGroup.FieldConfig fc) Deprecated. Inject field instance and use typed component instead of this method.
default java.lang.Object	getFieldValue(java.lang.String fieldId) Deprecated. Inject field instance and use typed component instead of this method.
java.util.List<Component>	getOwnComponents() Get all components directly owned by this container
default java.lang.String	getRequiredMessage(FieldGroup.FieldConfig field) Deprecated. Use FieldConfig.getRequiredMessage() instead.
default java.lang.String	getRequiredMessage(java.lang.String fieldId) Deprecated. Use FieldGroup.getFieldNN(fieldId).getRequiredMessage() instead.
default java.lang.Object	getSubPart(java.lang.String name)
default boolean	isEditable(FieldGroup.FieldConfig field) Deprecated. Use FieldConfig.isEditable() instead.
default boolean	isEditable(java.lang.String fieldId) Deprecated. Use FieldGroup.getFieldNN(fieldId).isEditable()
default boolean	isEnabled(FieldGroup.FieldConfig fc) Deprecated. Use FieldConfig.isEnabled() instead.
default boolean	isEnabled(java.lang.String fieldId) Deprecated. Use FieldGroup.getFieldNN(fieldId).isEnabled()
default boolean	isRequired(FieldGroup.FieldConfig fc) Deprecated. Use FieldConfig.isRequired() instead.
default boolean	isRequired(java.lang.String fieldId) Deprecated. Use FieldGroup.getFieldNN(fieldId).isRequired() instead.
boolean	isValid()
default boolean	isValidateOnCommit() Enable/disable component validation on window commit for methods Window.validateAll(), Frame.validate(), Frame.validateAll(), Frame.isValid() By default is true and component is validated on window commit.
default boolean	isVisible(FieldGroup.FieldConfig fc) Deprecated. Use FieldConfig.isVisible() instead.
default boolean	isVisible(java.lang.String fieldId) Deprecated. Use FieldGroup.getFieldNN("fieldId").isVisible()
void	removeField(FieldGroup.FieldConfig fieldConfig) Remove field associated with fieldConfig.
void	removeField(java.lang.String fieldId) Remove field by id.
default void	requestFocus() Deprecated. Use focusFirstField() instead.
default void	requestFocus(java.lang.String fieldId) Deprecated. Use focusField(String) instead.
void	setCaptionAlignment(FieldGroup.FieldCaptionAlignment captionAlignment) Set alignment of field captions
void	setColumnExpandRatio(int colIndex, float ratio) Set column expand ratio.
void	setColumns(int columns) Set column count.
void	setDatasource(Datasource datasource) Set default datasource for declarative fields.
default void	setEditable(FieldGroup.FieldConfig field, boolean editable) Deprecated. Use FieldConfig.setEditable(editable) instead.
default void	setEditable(java.lang.String fieldId, boolean editable) Deprecated. Use FieldGroup.getFieldNN(fieldId).setEditable(editable) instead.
default void	setEnabled(FieldGroup.FieldConfig fc, boolean enabled) Deprecated. Use FieldConfig.setEnabled(enabled) instead.
default void	setEnabled(java.lang.String fieldId, boolean enabled) Deprecated. Use FieldGroup.getFieldNN(fieldId).setEnabled(enabled) instead.
default void	setFieldCaption(java.lang.String fieldId, java.lang.String caption) Deprecated. Use FieldGroup.getFieldNN(fieldId).setCaption(caption) instead.
void	setFieldCaptionWidth(int fixedCaptionWidth) Set fixed field captions width.
void	setFieldCaptionWidth(int colIndex, int width) Set fixed field captions width for column colIndex.
void	setFieldFactory(FieldGroupFieldFactory fieldFactory) Set field factory for declarative fields.
default void	setFieldValue(FieldGroup.FieldConfig fc, java.lang.Object value) Deprecated. Inject field instance and use typed component instead of this method.
default void	setFieldValue(java.lang.String fieldId, java.lang.Object value) Deprecated. Inject field instance and use typed component instead of this method.
default void	setRequired(FieldGroup.FieldConfig field, boolean required) Deprecated. Use FieldConfig.setRequired(required) instead.
default void	setRequired(FieldGroup.FieldConfig field, boolean required, java.lang.String message) Deprecated. Use FieldConfig.setRequired(required) instead.
default void	setRequired(java.lang.String fieldId, boolean required) Deprecated. Use FieldGroup.getFieldNN(fieldId).setRequired(fieldId) instead.
default void	setRequired(java.lang.String fieldId, boolean required, java.lang.String message) Deprecated. Use FieldGroup.getFieldNN(fieldId).setRequired(required) instead.
default void	setRequiredMessage(FieldGroup.FieldConfig field, java.lang.String message) Deprecated. Use FieldConfig.setRequiredMessage(message) instead.
default void	setRequiredMessage(java.lang.String fieldId, java.lang.String message) Deprecated. Use FieldGroup.getFieldNN(fieldId).setRequiredMessage(message) instead.
default void	setVisible(FieldGroup.FieldConfig fc, boolean visible) Deprecated. Use FieldConfig.setVisible(visible) instead.
default void	setVisible(java.lang.String fieldId, boolean visible) Deprecated. Use FieldGroup.getFieldNN(fieldId).setVisible(visible) instead.
void	validate()

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

getFrame, setFrame

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

getCaption, setCaption

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

getDescription, setDescription

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

getIcon, setIcon, setIconFromSet

Methods inherited from interface com.haulmont.cuba.gui.components.HasBorder

isBorderVisible, setBorderVisible

Methods inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface com.haulmont.cuba.gui.components.EditableChangeNotifier

addEditableChangeListener, removeEditableChangeListener

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

isEditable, isEditableWithParent, setEditable

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

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Methods inherited from interface com.haulmont.cuba.gui.components.ComponentContainer

add, add, focusFirstComponent, getComponent, getComponentNN, getComponents, getOwnComponent, getOwnComponentsStream, remove, remove, removeAll

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

createField

FieldGroup.FieldConfig createField(java.lang.String id)

Create new field config. Field will not be automatically added to layout use additional addField(FieldConfig) call.

Parameters:

id - field id

Returns:

field config

getFields

java.util.List<FieldGroup.FieldConfig> getFields()

Returns:

all added field configs

getFields

java.util.List<FieldGroup.FieldConfig> getFields(int column)

Parameters:

column - column index

Returns:

added field configs of column

getField

FieldGroup.FieldConfig getField(int column,
                                int row)

Parameters:

column - column index

row - row index

Returns:

field config

getField

@Nullable
FieldGroup.FieldConfig getField(java.lang.String fieldId)

Get field config by id.

Parameters:

fieldId - field id

Returns:

field config or null

getFieldNN

FieldGroup.FieldConfig getFieldNN(java.lang.String fieldId)

Get field config by id.

Parameters:

fieldId - field id

Returns:

field config. Throws exception if not found.

addField

void addField(FieldGroup.FieldConfig field)

Append field to 1 column.

Parameters:

field - field config

addField

void addField(FieldGroup.FieldConfig fieldConfig,
              int colIndex)

Append field to colIndex column.

Parameters:

fieldConfig - field config

colIndex - column index

addField

void addField(FieldGroup.FieldConfig fieldConfig,
              int colIndex,
              int rowIndex)

Insert field to colIndex column to rowIndex position.

Parameters:

fieldConfig - field config

colIndex - column index

rowIndex - row index

removeField

void removeField(java.lang.String fieldId)

Remove field by id.

Parameters:

fieldId - field id

removeField

void removeField(FieldGroup.FieldConfig fieldConfig)

Remove field associated with fieldConfig.

Parameters:

fieldConfig - field id

requestFocus

@Deprecated
default void requestFocus(java.lang.String fieldId)

Deprecated. Use focusField(String) instead.

Request focus on field.
Throws exception if field is not found or field does not have component.

Parameters:

fieldId - field id

requestFocus

@Deprecated
default void requestFocus()

Deprecated. Use focusFirstField() instead.

Description copied from interface: Component

Set focus to this component

Specified by:

requestFocus in interface Component

focusFirstField

void focusFirstField()

Focus the first enabled, visible and editable field.

focusField

void focusField(java.lang.String fieldId)

Request focus on field.
Throws exception if field is not found or field does not have component.

Parameters:

fieldId - field id

getDatasource

Datasource getDatasource()

Returns:

default datasource for declarative fields

setDatasource

void setDatasource(Datasource datasource)

Set default datasource for declarative fields.

Parameters:

datasource - datasource

bind

void bind()

Create and bind components for all declarative fields.

getOwnComponents

java.util.List<Component> getOwnComponents()

Description copied from interface: ComponentContainer

Get all components directly owned by this container

Specified by:

getOwnComponents in interface ComponentContainer

Returns:

attached field components

getCaptionAlignment

FieldGroup.FieldCaptionAlignment getCaptionAlignment()

Returns:

alignment of field captions

setCaptionAlignment

void setCaptionAlignment(FieldGroup.FieldCaptionAlignment captionAlignment)

Set alignment of field captions

Parameters:

captionAlignment - field captions alignment

getFieldCaptionWidth

int getFieldCaptionWidth()

Returns:

fixed field caption width

setFieldCaptionWidth

void setFieldCaptionWidth(int fixedCaptionWidth)

Set fixed field captions width. Set -1 to use auto size.

Parameters:

fixedCaptionWidth - fixed field caption width

getFieldCaptionWidth

int getFieldCaptionWidth(int colIndex)

Parameters:

colIndex - column index

Returns:

fixed field caption width for column colIndex

setFieldCaptionWidth

void setFieldCaptionWidth(int colIndex,
                          int width)

Set fixed field captions width for column colIndex. Set -1 to use auto size.

Parameters:

colIndex - column index

width - width

getColumns

int getColumns()

Returns:

column count

setColumns

void setColumns(int columns)

Set column count.

Parameters:

columns - column count

getColumnExpandRatio

float getColumnExpandRatio(int colIndex)

Parameters:

colIndex - column index

Returns:

column expand ratio

setColumnExpandRatio

void setColumnExpandRatio(int colIndex,
                          float ratio)

Set column expand ratio.

Parameters:

colIndex - column index

ratio - column expand ratio

isValid

boolean isValid()

Specified by:

isValid in interface Validatable

validate

void validate()
       throws ValidationException

Specified by:

validate in interface Validatable

Throws:

ValidationException

getFieldFactory

FieldGroupFieldFactory getFieldFactory()

Returns:

field factory for declarative fields

setFieldFactory

void setFieldFactory(FieldGroupFieldFactory fieldFactory)

Set field factory for declarative fields.

Parameters:

fieldFactory - field factory

isValidateOnCommit

default boolean isValidateOnCommit()

Description copied from interface: Validatable

Enable/disable component validation on window commit for methods Window.validateAll(), Frame.validate(), Frame.validateAll(), Frame.isValid() By default is true and component is validated on window commit. For FieldGroup is false.

Specified by:

isValidateOnCommit in interface Validatable

getSubPart

@Nullable
default java.lang.Object getSubPart(java.lang.String name)

Specified by:

getSubPart in interface HasSubParts

getFieldComponent

@Deprecated
default Component getFieldComponent(java.lang.String id)

Deprecated.

getFieldComponent

@Deprecated
default Component getFieldComponent(FieldGroup.FieldConfig fieldConfig)

Deprecated.

isRequired

@Deprecated
default boolean isRequired(FieldGroup.FieldConfig fc)

Deprecated. Use FieldConfig.isRequired() instead.

setRequired

@Deprecated
default void setRequired(FieldGroup.FieldConfig field,
                                     boolean required,
                                     java.lang.String message)

Deprecated. Use FieldConfig.setRequired(required) instead.

setRequired

@Deprecated
default void setRequired(FieldGroup.FieldConfig field,
                                     boolean required)

Deprecated. Use FieldConfig.setRequired(required) instead.

getRequiredMessage

@Deprecated
default java.lang.String getRequiredMessage(FieldGroup.FieldConfig field)

Deprecated. Use FieldConfig.getRequiredMessage() instead.

setRequiredMessage

@Deprecated
default void setRequiredMessage(FieldGroup.FieldConfig field,
                                            java.lang.String message)

Deprecated. Use FieldConfig.setRequiredMessage(message) instead.

isRequired

@Deprecated
default boolean isRequired(java.lang.String fieldId)

Deprecated. Use FieldGroup.getFieldNN(fieldId).isRequired() instead.

setRequired

@Deprecated
default void setRequired(java.lang.String fieldId,
                                     boolean required,
                                     java.lang.String message)

Deprecated. Use FieldGroup.getFieldNN(fieldId).setRequired(required) instead.

setRequired

@Deprecated
default void setRequired(java.lang.String fieldId,
                                     boolean required)

Deprecated. Use FieldGroup.getFieldNN(fieldId).setRequired(fieldId) instead.

getRequiredMessage

@Deprecated
default java.lang.String getRequiredMessage(java.lang.String fieldId)

Deprecated. Use FieldGroup.getFieldNN(fieldId).getRequiredMessage() instead.

setRequiredMessage

@Deprecated
default void setRequiredMessage(java.lang.String fieldId,
                                            java.lang.String message)

Deprecated. Use FieldGroup.getFieldNN(fieldId).setRequiredMessage(message) instead.

addValidator

@Deprecated
default void addValidator(FieldGroup.FieldConfig field,
                                      Field.Validator validator)

Deprecated. Use FieldConfig.addValidator(validator) instead.

addValidator

@Deprecated
default void addValidator(java.lang.String fieldId,
                                      Field.Validator validator)

Deprecated. Use FieldGroup.getFieldNN(fieldId).addValidator(validator) instead.

isEditable

@Deprecated
default boolean isEditable(FieldGroup.FieldConfig field)

Deprecated. Use FieldConfig.isEditable() instead.

setEditable

@Deprecated
default void setEditable(FieldGroup.FieldConfig field,
                                     boolean editable)

Deprecated. Use FieldConfig.setEditable(editable) instead.

isEditable

@Deprecated
default boolean isEditable(java.lang.String fieldId)

Deprecated. Use FieldGroup.getFieldNN(fieldId).isEditable()

setEditable

@Deprecated
default void setEditable(java.lang.String fieldId,
                                     boolean editable)

Deprecated. Use FieldGroup.getFieldNN(fieldId).setEditable(editable) instead.

isEnabled

@Deprecated
default boolean isEnabled(FieldGroup.FieldConfig fc)

Deprecated. Use FieldConfig.isEnabled() instead.

setEnabled

@Deprecated
default void setEnabled(FieldGroup.FieldConfig fc,
                                    boolean enabled)

Deprecated. Use FieldConfig.setEnabled(enabled) instead.

isEnabled

@Deprecated
default boolean isEnabled(java.lang.String fieldId)

Deprecated. Use FieldGroup.getFieldNN(fieldId).isEnabled()

setEnabled

@Deprecated
default void setEnabled(java.lang.String fieldId,
                                    boolean enabled)

Deprecated. Use FieldGroup.getFieldNN(fieldId).setEnabled(enabled) instead.

isVisible

@Deprecated
default boolean isVisible(FieldGroup.FieldConfig fc)

Deprecated. Use FieldConfig.isVisible() instead.

setVisible

@Deprecated
default void setVisible(FieldGroup.FieldConfig fc,
                                    boolean visible)

Deprecated. Use FieldConfig.setVisible(visible) instead.

isVisible

@Deprecated
default boolean isVisible(java.lang.String fieldId)

Deprecated. Use FieldGroup.getFieldNN("fieldId").isVisible()

setVisible

@Deprecated
default void setVisible(java.lang.String fieldId,
                                    boolean visible)

Deprecated. Use FieldGroup.getFieldNN(fieldId).setVisible(visible) instead.

getFieldValue

@Deprecated
default java.lang.Object getFieldValue(FieldGroup.FieldConfig fc)

Deprecated. Inject field instance and use typed component instead of this method.

setFieldValue

@Deprecated
default void setFieldValue(FieldGroup.FieldConfig fc,
                                       java.lang.Object value)

Deprecated. Inject field instance and use typed component instead of this method.

getFieldValue

@Deprecated
default java.lang.Object getFieldValue(java.lang.String fieldId)

Deprecated. Inject field instance and use typed component instead of this method.

setFieldValue

@Deprecated
default void setFieldValue(java.lang.String fieldId,
                                       java.lang.Object value)

Deprecated. Inject field instance and use typed component instead of this method.

getFieldCaption

@Deprecated
default java.lang.String getFieldCaption(java.lang.String fieldId)

Deprecated. Use FieldGroup.getFieldNN(fieldId).getCaption() instead.

setFieldCaption

@Deprecated
default void setFieldCaption(java.lang.String fieldId,
                                         java.lang.String caption)

Deprecated. Use FieldGroup.getFieldNN(fieldId).setCaption(caption) instead.

addCustomField

@Deprecated
void addCustomField(FieldGroup.FieldConfig field,
                                FieldGroup.CustomFieldGenerator fieldGenerator)

Deprecated. Set Component implementation directly to FieldGroup.FieldConfig using FieldGroup.FieldConfig.setComponent(Component) method.

Generate and set Component to custom field.

Parameters:

field - field config

fieldGenerator - field generator

addCustomField

@Deprecated
void addCustomField(java.lang.String fieldId,
                                FieldGroup.CustomFieldGenerator fieldGenerator)

Deprecated. Set Component implementation directly to FieldGroup.FieldConfig using FieldGroup.FieldConfig.setComponent(Component) method.

Generate and set Component to custom field.

Parameters:

fieldId - field id

fieldGenerator - field generator