info.magnolia.ui.form.field.definition

Class SelectFieldDefinition

java.lang.Object

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

info.magnolia.ui.form.field.definition.SelectFieldDefinition

All Implemented Interfaces:

FieldDefinition

Direct Known Subclasses:

NodeTypeSelectFieldDefinition, OptionGroupFieldDefinition, SystemLanguagesFieldDefinition, TimeZoneFieldFactory.Definition

public class SelectFieldDefinition
extends ConfiguredFieldDefinition

Basic definition class for various types of select fields.

Offers two distinct ways of populating selection options:

• an explicit set of option definitions can be provided via setOptions(List)
• if no explicit options are specified - option set can be resolved from a remote path in JCR repository by means of  setPath(String), setLabelProperty(String) and setValueProperty(String) methods

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_REPOSITORY_NAME
static String	OPTION_ICONSRC_PROPERTY_NAME
static String	OPTION_LABEL_PROPERTY_NAME
static String	OPTION_NAME_PROPERTY_NAME
static String	OPTION_SELECTED_PROPERTY_NAME
static String	OPTION_VALUE_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
SelectFieldDefinition()

Method Summary

Modifier and Type	Method and Description
void	addOption(SelectFieldOptionDefinition option)
Class<? extends Comparator<SelectFieldOptionDefinition>>	getComparatorClass()
com.vaadin.v7.shared.ui.combobox.FilteringMode	getFilteringMode() Defines the filtering mode (off, startswith, contains) of this select field.
String	getLabelProperty()
List<SelectFieldOptionDefinition>	getOptions()
int	getPageLength()
String	getPath()
String	getRepository()
String	getValueProperty()
boolean	isSortOptions()
boolean	isTextInputAllowed()
void	setComparatorClass(Class<? extends Comparator<SelectFieldOptionDefinition>> comparatorClass)
void	setFilteringMode(com.vaadin.v7.shared.ui.combobox.FilteringMode filteringMode)
void	setFilteringMode(int filteringMode) Deprecated. since 5.3.15, use setFilteringMode(FilteringMode) instead.
void	setLabelProperty(String labelProperty)
void	setOptions(List<SelectFieldOptionDefinition> options)
void	setPageLength(int pageLength)
void	setPath(String path)
void	setRepository(String repository)
void	setSortOptions(boolean sortOptions) By default, options labels are sorted alphabetically (in ascending order) unless false is specified.
void	setTextInputAllowed(boolean textInputAllowed)
void	setValueProperty(String valueProperty)

Methods inherited from class info.magnolia.ui.form.field.definition.ConfiguredFieldDefinition

addValidator, getConverterClass, getDefaultValue, getDescription, getI18nBasename, getLabel, getName, getRequiredErrorMessage, getStyleName, getTransformerClass, getType, getValidators, isI18n, isReadOnly, isRequired, setConverterClass, setDefaultValue, setDescription, setI18n, setI18nBasename, setLabel, setName, setReadOnly, setRequired, setRequiredErrorMessage, setStyleName, setTransformerClass, setType, setValidators

Methods inherited from class java.lang.Object

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

Field Detail

OPTION_VALUE_PROPERTY_NAME

public static final String OPTION_VALUE_PROPERTY_NAME

See Also:

Constant Field Values

OPTION_NAME_PROPERTY_NAME

public static final String OPTION_NAME_PROPERTY_NAME

See Also:

Constant Field Values

OPTION_SELECTED_PROPERTY_NAME

public static final String OPTION_SELECTED_PROPERTY_NAME

See Also:

Constant Field Values

OPTION_ICONSRC_PROPERTY_NAME

public static final String OPTION_ICONSRC_PROPERTY_NAME

See Also:

Constant Field Values

OPTION_LABEL_PROPERTY_NAME

public static final String OPTION_LABEL_PROPERTY_NAME

See Also:

Constant Field Values

DEFAULT_REPOSITORY_NAME

public static final String DEFAULT_REPOSITORY_NAME

See Also:

Constant Field Values

Constructor Detail

SelectFieldDefinition

public SelectFieldDefinition()

Method Detail

getOptions

public List<SelectFieldOptionDefinition> getOptions()

setOptions

public void setOptions(List<SelectFieldOptionDefinition> options)

addOption

public void addOption(SelectFieldOptionDefinition option)

getPath

public String getPath()

setPath

public void setPath(String path)

getRepository

public String getRepository()

setRepository

public void setRepository(String repository)

getValueProperty

public String getValueProperty()

setValueProperty

public void setValueProperty(String valueProperty)

getLabelProperty

public String getLabelProperty()

setLabelProperty

public void setLabelProperty(String labelProperty)

getFilteringMode

public com.vaadin.v7.shared.ui.combobox.FilteringMode getFilteringMode()

Defines the filtering mode (off, startswith, contains) of this select field. Additionally, mind that filtering mode is only enabled with paging, i.e. when the pageLength property is greater than 0.

Returns:

a member of the FilteringMode enum. Defaults to off.

See Also:

com.vaadin.shared.ui.combobox.FilteringMode

setFilteringMode

public void setFilteringMode(com.vaadin.v7.shared.ui.combobox.FilteringMode filteringMode)

setFilteringMode

@Deprecated
public void setFilteringMode(int filteringMode)

Deprecated. since 5.3.15, use setFilteringMode(FilteringMode) instead.

setSortOptions

public void setSortOptions(boolean sortOptions)

By default, options labels are sorted alphabetically (in ascending order) unless false is specified. In that case, the JCR "natural order" should be kept.

isSortOptions

public boolean isSortOptions()

getComparatorClass

public Class<? extends Comparator<SelectFieldOptionDefinition>> getComparatorClass()

setComparatorClass

public void setComparatorClass(Class<? extends Comparator<SelectFieldOptionDefinition>> comparatorClass)

isTextInputAllowed

public boolean isTextInputAllowed()

setTextInputAllowed

public void setTextInputAllowed(boolean textInputAllowed)

getPageLength

public int getPageLength()

setPageLength

public void setPageLength(int pageLength)