Form component instead.@Deprecated public interface FieldGroup extends io.jmix.ui.component.Component, io.jmix.ui.component.Component.BelongToFrame, io.jmix.ui.component.Component.HasCaption, io.jmix.ui.component.Component.HasIcon, io.jmix.ui.component.HasBorder, io.jmix.ui.component.HasContextHelp, io.jmix.ui.component.Component.Editable, io.jmix.ui.component.Validatable, EditableChangeNotifier, io.jmix.ui.component.ChildEditableController, io.jmix.ui.component.ComponentContainer, io.jmix.ui.component.HasSubParts, io.jmix.ui.component.HasHtmlSanitizer
| 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
Deprecated.
Whether apply declarative defaults for custom field or not.
|
static class |
FieldGroup.FieldCaptionAlignment
Deprecated.
Field caption alignment.
|
static interface |
FieldGroup.FieldConfig
Deprecated.
Configuration of a field.
|
static class |
FieldGroup.FieldsValidationException
Deprecated.
Exception that is thrown from
validate(). |
io.jmix.ui.component.HasContextHelp.ContextHelpIconClickEventio.jmix.ui.component.EditableChangeNotifier.EditableChangeEventio.jmix.ui.component.Component.Alignment, io.jmix.ui.component.Component.BelongToFrame, io.jmix.ui.component.Component.Disposable, io.jmix.ui.component.Component.Editable, io.jmix.ui.component.Component.Focusable, io.jmix.ui.component.Component.HasCaption, io.jmix.ui.component.Component.HasDescription, io.jmix.ui.component.Component.HasIcon, io.jmix.ui.component.Component.HasXmlDescriptor, io.jmix.ui.component.Component.Wrapper| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
NAME
Deprecated.
|
| 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)
Deprecated.
Append field to 1 column.
|
void |
addField(FieldGroup.FieldConfig fieldConfig,
int colIndex)
Deprecated.
Append field to
colIndex column. |
void |
addField(FieldGroup.FieldConfig fieldConfig,
int colIndex,
int rowIndex)
Deprecated.
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()
Deprecated.
Create and bind components for all declarative fields.
|
FieldGroup.FieldConfig |
createField(java.lang.String id)
Deprecated.
Create new field config.
|
void |
focusField(java.lang.String fieldId)
Deprecated.
Request focus on field.
|
void |
focusFirstField()
Deprecated.
Focus the first enabled, visible and editable field.
|
FieldGroup.FieldCaptionAlignment |
getCaptionAlignment()
Deprecated.
|
float |
getColumnExpandRatio(int colIndex)
Deprecated.
|
int |
getColumns()
Deprecated.
|
Datasource |
getDatasource()
Deprecated.
|
FieldGroup.FieldConfig |
getField(int column,
int row)
Deprecated.
|
FieldGroup.FieldConfig |
getField(java.lang.String fieldId)
Deprecated.
Get field config by id.
|
default java.lang.String |
getFieldCaption(java.lang.String fieldId)
Deprecated.
Use
FieldGroup.getFieldNN(fieldId).getCaption() instead. |
int |
getFieldCaptionWidth()
Deprecated.
|
int |
getFieldCaptionWidth(int colIndex)
Deprecated.
|
default io.jmix.ui.component.Component |
getFieldComponent(FieldGroup.FieldConfig fieldConfig)
Deprecated.
|
default io.jmix.ui.component.Component |
getFieldComponent(java.lang.String id)
Deprecated.
|
FieldGroupFieldFactory |
getFieldFactory()
Deprecated.
|
FieldGroup.FieldConfig |
getFieldNN(java.lang.String fieldId)
Deprecated.
Get field config by id.
|
java.util.List<FieldGroup.FieldConfig> |
getFields()
Deprecated.
|
java.util.List<FieldGroup.FieldConfig> |
getFields(int column)
Deprecated.
|
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<io.jmix.ui.component.Component> |
getOwnComponents()
Deprecated.
|
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)
Deprecated.
|
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()
Deprecated.
|
default boolean |
isValidateOnCommit()
Deprecated.
|
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)
Deprecated.
Remove field associated with
fieldConfig. |
void |
removeField(java.lang.String fieldId)
Deprecated.
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)
Deprecated.
Set alignment of field captions
|
void |
setColumnExpandRatio(int colIndex,
float ratio)
Deprecated.
Set column expand ratio.
|
void |
setColumns(int columns)
Deprecated.
Set column count.
|
void |
setDatasource(Datasource datasource)
Deprecated.
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)
Deprecated.
Set fixed field captions width.
|
void |
setFieldCaptionWidth(int colIndex,
int width)
Deprecated.
Set fixed field captions width for column
colIndex. |
void |
setFieldFactory(FieldGroupFieldFactory fieldFactory)
Deprecated.
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()
Deprecated.
|
getDescription, setDescriptiongetIcon, setIcon, setIconFromSetgetContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabledremoveEditableChangeListeneraddEditableChangeListenerisEditable, isEditableWithParent, setEditableaddStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedCompositionadd, add, remove, remove, removeAllstatic final java.lang.String NAME
FieldGroup.FieldConfig createField(java.lang.String id)
addField(FieldConfig) call.id - field idjava.util.List<FieldGroup.FieldConfig> getFields()
java.util.List<FieldGroup.FieldConfig> getFields(int column)
column - column indexcolumnFieldGroup.FieldConfig getField(int column, int row)
column - column indexrow - row index@Nullable FieldGroup.FieldConfig getField(java.lang.String fieldId)
fieldId - field idFieldGroup.FieldConfig getFieldNN(java.lang.String fieldId)
fieldId - field idvoid addField(FieldGroup.FieldConfig field)
field - field configvoid addField(FieldGroup.FieldConfig fieldConfig, int colIndex)
colIndex column.fieldConfig - field configcolIndex - column indexvoid addField(FieldGroup.FieldConfig fieldConfig, int colIndex, int rowIndex)
colIndex column to rowIndex position.fieldConfig - field configcolIndex - column indexrowIndex - row indexvoid removeField(java.lang.String fieldId)
fieldId - field idvoid removeField(FieldGroup.FieldConfig fieldConfig)
fieldConfig.fieldConfig - field id@Deprecated default void requestFocus(java.lang.String fieldId)
focusField(String) instead.fieldId - field id@Deprecated default void requestFocus()
focusFirstField() instead.void focusFirstField()
void focusField(java.lang.String fieldId)
fieldId - field idDatasource getDatasource()
void setDatasource(Datasource datasource)
datasource - datasourcevoid bind()
java.util.List<io.jmix.ui.component.Component> getOwnComponents()
getOwnComponents in interface io.jmix.ui.component.HasComponentsFieldGroup.FieldCaptionAlignment getCaptionAlignment()
void setCaptionAlignment(FieldGroup.FieldCaptionAlignment captionAlignment)
captionAlignment - field captions alignmentint getFieldCaptionWidth()
void setFieldCaptionWidth(int fixedCaptionWidth)
fixedCaptionWidth - fixed field caption widthint getFieldCaptionWidth(int colIndex)
colIndex - column indexcolIndexvoid setFieldCaptionWidth(int colIndex,
int width)
colIndex. Set -1 to use auto size.colIndex - column indexwidth - widthint getColumns()
void setColumns(int columns)
columns - column countfloat getColumnExpandRatio(int colIndex)
colIndex - column indexvoid setColumnExpandRatio(int colIndex,
float ratio)
colIndex - column indexratio - column expand ratioboolean isValid()
isValid in interface io.jmix.ui.component.Validatablevoid validate()
throws io.jmix.ui.component.ValidationException
validate in interface io.jmix.ui.component.Validatableio.jmix.ui.component.ValidationExceptionFieldGroupFieldFactory getFieldFactory()
void setFieldFactory(FieldGroupFieldFactory fieldFactory)
fieldFactory - field factorydefault boolean isValidateOnCommit()
isValidateOnCommit in interface io.jmix.ui.component.Validatable@Nullable default java.lang.Object getSubPart(java.lang.String name)
getSubPart in interface io.jmix.ui.component.HasSubParts@Deprecated default io.jmix.ui.component.Component getFieldComponent(java.lang.String id)
@Deprecated default io.jmix.ui.component.Component getFieldComponent(FieldGroup.FieldConfig fieldConfig)
@Deprecated default boolean isRequired(FieldGroup.FieldConfig fc)
FieldConfig.isRequired() instead.@Deprecated default void setRequired(FieldGroup.FieldConfig field, boolean required, java.lang.String message)
FieldConfig.setRequired(required) instead.@Deprecated default void setRequired(FieldGroup.FieldConfig field, boolean required)
FieldConfig.setRequired(required) instead.@Deprecated default java.lang.String getRequiredMessage(FieldGroup.FieldConfig field)
FieldConfig.getRequiredMessage() instead.@Deprecated default void setRequiredMessage(FieldGroup.FieldConfig field, java.lang.String message)
FieldConfig.setRequiredMessage(message) instead.@Deprecated default boolean isRequired(java.lang.String fieldId)
FieldGroup.getFieldNN(fieldId).isRequired() instead.@Deprecated
default void setRequired(java.lang.String fieldId,
boolean required,
java.lang.String message)
FieldGroup.getFieldNN(fieldId).setRequired(required) instead.@Deprecated
default void setRequired(java.lang.String fieldId,
boolean required)
FieldGroup.getFieldNN(fieldId).setRequired(fieldId) instead.@Deprecated default java.lang.String getRequiredMessage(java.lang.String fieldId)
FieldGroup.getFieldNN(fieldId).getRequiredMessage() instead.@Deprecated
default void setRequiredMessage(java.lang.String fieldId,
java.lang.String message)
FieldGroup.getFieldNN(fieldId).setRequiredMessage(message) instead.@Deprecated default void addValidator(FieldGroup.FieldConfig field, Field.Validator validator)
FieldConfig.addValidator(validator) instead.@Deprecated
default void addValidator(java.lang.String fieldId,
Field.Validator validator)
FieldGroup.getFieldNN(fieldId).addValidator(validator) instead.@Deprecated default boolean isEditable(FieldGroup.FieldConfig field)
FieldConfig.isEditable() instead.@Deprecated default void setEditable(FieldGroup.FieldConfig field, boolean editable)
FieldConfig.setEditable(editable) instead.@Deprecated default boolean isEditable(java.lang.String fieldId)
FieldGroup.getFieldNN(fieldId).isEditable()@Deprecated
default void setEditable(java.lang.String fieldId,
boolean editable)
FieldGroup.getFieldNN(fieldId).setEditable(editable) instead.@Deprecated default boolean isEnabled(FieldGroup.FieldConfig fc)
FieldConfig.isEnabled() instead.@Deprecated default void setEnabled(FieldGroup.FieldConfig fc, boolean enabled)
FieldConfig.setEnabled(enabled) instead.@Deprecated default boolean isEnabled(java.lang.String fieldId)
FieldGroup.getFieldNN(fieldId).isEnabled()@Deprecated
default void setEnabled(java.lang.String fieldId,
boolean enabled)
FieldGroup.getFieldNN(fieldId).setEnabled(enabled) instead.@Deprecated default boolean isVisible(FieldGroup.FieldConfig fc)
FieldConfig.isVisible() instead.@Deprecated default void setVisible(FieldGroup.FieldConfig fc, boolean visible)
FieldConfig.setVisible(visible) instead.@Deprecated default boolean isVisible(java.lang.String fieldId)
FieldGroup.getFieldNN("fieldId").isVisible()@Deprecated
default void setVisible(java.lang.String fieldId,
boolean visible)
FieldGroup.getFieldNN(fieldId).setVisible(visible) instead.@Deprecated default java.lang.Object getFieldValue(FieldGroup.FieldConfig fc)
@Deprecated default void setFieldValue(FieldGroup.FieldConfig fc, java.lang.Object value)
@Deprecated default java.lang.Object getFieldValue(java.lang.String fieldId)
@Deprecated
default void setFieldValue(java.lang.String fieldId,
java.lang.Object value)
@Deprecated default java.lang.String getFieldCaption(java.lang.String fieldId)
FieldGroup.getFieldNN(fieldId).getCaption() instead.@Deprecated
default void setFieldCaption(java.lang.String fieldId,
java.lang.String caption)
FieldGroup.getFieldNN(fieldId).setCaption(caption) instead.@Deprecated void addCustomField(FieldGroup.FieldConfig field, FieldGroup.CustomFieldGenerator fieldGenerator)
FieldGroup.FieldConfig using FieldGroup.FieldConfig.setComponent(Component) method.field - field configfieldGenerator - field generator@Deprecated
void addCustomField(java.lang.String fieldId,
FieldGroup.CustomFieldGenerator fieldGenerator)
FieldGroup.FieldConfig using FieldGroup.FieldConfig.setComponent(Component) method.fieldId - field idfieldGenerator - field generator