info.magnolia.ui.form.field.definition

Interface FieldDefinition

All Known Implementing Classes:

BasicTextCodeFieldDefinition, BasicUploadFieldDefinition, CheckboxFieldDefinition, ComponentSelectorDefinition, CompositeFieldDefinition, ConditionalReadOnlyTextFieldDefinition, ConfiguredFieldDefinition, DateFieldDefinition, EnabledFieldDefinition, GroupManagementFieldDefinition, HiddenFieldDefinition, LinkFieldDefinition, LinkFieldSelectionDefinition, MultiValueFieldDefinition, OptionGroupFieldDefinition, PasswordFieldDefinition, RichTextFieldDefinition, RoleManagementFieldDefinition, SelectFieldDefinition, StaticFieldDefinition, SwitchableFieldDefinition, SystemLanguagesFieldDefinition, TemplateSelectorDefinition, TextFieldDefinition, TwinColSelectFieldDefinition, WebAccessFieldDefinition, WorkbenchFieldDefinition, WorkspaceAccessFieldDefinition

public interface FieldDefinition

Defines a field within a dialog.

See Also:

FieldDefinition, FieldValidatorDefinition

Method Summary

Methods

Modifier and Type	Method and Description
String	getDefaultValue() Pre-filled value displayed in the field.
String	getDescription() Description displayed to the user when clicking on the Info Button.
String	getI18nBasename() Message bundle for localized field labels.
String	getLabel() Text displayed as field label.
String	getName() Determines the name of the data property where the value entered by the user is stored.
String	getRequiredErrorMessage() Error message text displayed in case of required = true.
String	getStyleName() Define a specific Field styleName.
Class<? extends Transformer<?>>	getTransformerClass()
String	getType() The type of this field when stored in a JCR repository expressed as a JCR property type name.
List<FieldValidatorDefinition>	getValidators()
boolean	isI18n() Enables i18n authoring support.
boolean	isReadOnly() Determines if a Field Property can be changed.
boolean	isRequired() Makes the field mandatory.

Method Detail

getName

String getName()

Determines the name of the data property where the value entered by the user is stored.

isRequired

boolean isRequired()

Makes the field mandatory.

getRequiredErrorMessage

String getRequiredErrorMessage()

Error message text displayed in case of required = true.

getType

String getType()

The type of this field when stored in a JCR repository expressed as a JCR property type name.

See Also:

PropertyType

getLabel

String getLabel()

Text displayed as field label.

getI18nBasename

String getI18nBasename()

Message bundle for localized field labels.

getDescription

String getDescription()

Description displayed to the user when clicking on the Info Button.

getDefaultValue

String getDefaultValue()

Pre-filled value displayed in the field. The value can be overwritten by the user.

isReadOnly

boolean isReadOnly()

Determines if a Field Property can be changed.

isI18n

boolean isI18n()

Enables i18n authoring support. This allows authors to write foreign language or regionally targeted content. A two-letter language identifier (en, ge, fr etc.) is displayed on controls where i18n is set to true.

getStyleName

String getStyleName()

Define a specific Field styleName. This style definition will be added to the Field Style by calling AbstractComponent.addStyleName.

getValidators

List<FieldValidatorDefinition> getValidators()

getTransformerClass

Class<? extends Transformer<?>> getTransformerClass()