info.magnolia.ui.form.field.definition
Class ConfiguredFieldDefinition

java.lang.Object
  info.magnolia.ui.form.field.definition.ConfiguredFieldDefinition

All Implemented Interfaces:

FieldDefinition

Direct Known Subclasses:

BasicTextCodeFieldDefinition, BasicUploadFieldDefinition, CheckboxFieldDefinition, CompositeFieldDefinition, DateFieldDefinition, HiddenFieldDefinition, LinkFieldDefinition, LinkFieldSelectionDefinition, MultiValueFieldDefinition, PasswordFieldDefinition, RichTextFieldDefinition, SelectFieldDefinition, StaticFieldDefinition, TextFieldDefinition, WebAccessFieldDefinition, WorkbenchFieldDefinition, WorkspaceAccessFieldDefinition

public class ConfiguredFieldDefinition
extends Object
implements FieldDefinition

Describes a field in a dialog.

Constructor Summary

ConfiguredFieldDefinition()

Method Summary

void	addValidator(FieldValidatorDefinition validator)
String	getDefaultValue() Pre-filled value displayed in the field.
String	getDescription() Description displayed to the user when clicking on the Info Button.
String	getI18nBasename() Deprecated. since 5.1. Use I18nizer mechanism instead.
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.
void	setDefaultValue(String defaultValue)
void	setDescription(String description)
void	setI18n(boolean i18n)
void	setI18nBasename(String i18nBasename) Deprecated. since 5.1. Use I18nizer mechanism instead.
void	setLabel(String label)
void	setName(String name)
void	setReadOnly(boolean readOnly)
void	setRequired(boolean required)
void	setRequiredErrorMessage(String requiredErrorMessage)
void	setStyleName(String styleName)
void	setTransformerClass(Class<? extends Transformer<?>> transformerClass)
void	setType(String type)
void	setValidators(List<FieldValidatorDefinition> validators)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfiguredFieldDefinition

public ConfiguredFieldDefinition()

Method Detail

getName

public String getName()

Description copied from interface: FieldDefinition

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

Specified by:

getName in interface FieldDefinition

getLabel

public String getLabel()

Description copied from interface: FieldDefinition

Text displayed as field label.

Specified by:

getLabel in interface FieldDefinition

getI18nBasename

@Deprecated
public String getI18nBasename()

Deprecated. since 5.1. Use I18nizer mechanism instead.

Description copied from interface: FieldDefinition

Message bundle for localized field labels.

Specified by:

getI18nBasename in interface FieldDefinition

getDescription

public String getDescription()

Description copied from interface: FieldDefinition

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

Specified by:

getDescription in interface FieldDefinition

getType

public String getType()

Description copied from interface: FieldDefinition

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

Specified by:

getType in interface FieldDefinition

See Also:

PropertyType

isRequired

public boolean isRequired()

Description copied from interface: FieldDefinition

Makes the field mandatory.

Specified by:

isRequired in interface FieldDefinition

getRequiredErrorMessage

public String getRequiredErrorMessage()

Description copied from interface: FieldDefinition

Error message text displayed in case of required = true.

Specified by:

getRequiredErrorMessage in interface FieldDefinition

getValidators

public List<FieldValidatorDefinition> getValidators()

Specified by:

getValidators in interface FieldDefinition

getDefaultValue

public String getDefaultValue()

Description copied from interface: FieldDefinition

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

Specified by:

getDefaultValue in interface FieldDefinition

isReadOnly

public boolean isReadOnly()

Description copied from interface: FieldDefinition

Determines if a Field Property can be changed.

Specified by:

isReadOnly in interface FieldDefinition

isI18n

public boolean isI18n()

Description copied from interface: FieldDefinition

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.

Specified by:

isI18n in interface FieldDefinition

getStyleName

public String getStyleName()

Description copied from interface: FieldDefinition

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

Specified by:

getStyleName in interface FieldDefinition

setStyleName

public void setStyleName(String styleName)

setI18n

public void setI18n(boolean i18n)

setRequiredErrorMessage

public void setRequiredErrorMessage(String requiredErrorMessage)

setReadOnly

public void setReadOnly(boolean readOnly)

setName

public void setName(String name)

setLabel

public void setLabel(String label)

setI18nBasename

@Deprecated
public void setI18nBasename(String i18nBasename)

Deprecated. since 5.1. Use I18nizer mechanism instead.

setDescription

public void setDescription(String description)

setType

public void setType(String type)

setRequired

public void setRequired(boolean required)

setValidators

public void setValidators(List<FieldValidatorDefinition> validators)

addValidator

public void addValidator(FieldValidatorDefinition validator)

setDefaultValue

public void setDefaultValue(String defaultValue)

getTransformerClass

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

Specified by:

getTransformerClass in interface FieldDefinition

setTransformerClass

public void setTransformerClass(Class<? extends Transformer<?>> transformerClass)