com.jalios.jcms.taglib.settings

Class SelectorSettings<T extends SelectorSettings<T>>

java.lang.Object

com.jalios.jcms.taglib.settings.BasicSettings<T>

com.jalios.jcms.taglib.settings.SelectorSettings<T>

Type Parameters:

T - Type of SelectorSettings

All Implemented Interfaces:

ControlSettings, java.lang.Cloneable

Direct Known Subclasses:

AbstractChooserSettings, BooleanSettings, DefaultSettings, EnumerateSettings

public abstract class SelectorSettings<T extends SelectorSettings<T>>
extends BasicSettings<T>

Abstract class to be implemented by each ControlSettings that supports fields "checkbox" (checkbox()), "radio" (radio()), "select" (select()) or "chooser" (chooser()).

Default is "radio".

Author:

ndossantos

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SelectorSettings.SelectorType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ENUM_LABEL_APPENDS
static java.lang.String	ENUM_LABEL_PREPENDS
static java.lang.String	ENUM_LABELS
static java.lang.String	ENUM_VALUES
static java.lang.String	INLINE
static java.lang.String	MULTIPLE
static java.lang.String	REQUIRED
static java.lang.String	SELECT_ITEM_EMPTY_VALUE
static java.lang.String	SELECTOR_TYPE

Fields inherited from class com.jalios.jcms.taglib.settings.BasicSettings

APPEND, AUTOFOCUS, CLEAR_BUTTON, CSS, DATA_ATTR_PREFIX, DATA_ATTRIBUTES, DISABLED, HIDE_CLEAR_BUTTON, HTML_ATTRIBUTES, ID, LANGUAGE_CHOOSER, MAX_LENGTH, NAME, PLACEHOLDER, PREPEND, READONLY, TRIGGER_ACTION, TRIGGER_EVENT, VALUE

Constructor Summary

Constructors

Constructor and Description
SelectorSettings()

Method Summary

Methods

Modifier and Type	Method and Description
T	checkbox()
T	chooser()
T	disableInline()
T	enumLabelAppends(java.util.Collection<java.lang.String> enumLabelAppends)
T	enumLabelAppends(java.lang.String[] enumLabelAppends)
T	enumLabelAppends(java.lang.String enumLabelAppend, java.lang.String... otherEnumLabelAppends)
T	enumLabelPreprends(java.util.Collection<java.lang.String> enumLabelPrepends)
T	enumLabelPreprends(java.lang.String[] enumLabelPrepends)
T	enumLabelPreprends(java.lang.String enumLabelPrepend, java.lang.String... otherEnumLabelPrepends)
T	enumLabels(java.util.Collection<java.lang.String> enumLabels)
T	enumLabels(java.lang.String[] enumLabels)
T	enumLabels(java.lang.String enumLabel, java.lang.String... otherEnumLabels)
T	enumValues(java.util.Collection<?> enumValues)
T	enumValues(java.lang.Object[] enumValues)
T	enumValues(java.lang.Object enumValue, java.lang.Object... otherEnumValues)
T	inline()
T	multiple() Specify whether multiple items can be selected.
T	radio()
T	required()
void	resolveOptions(TypeFieldEntry tfe) Set options from the specified TypeFieldEntry.
T	select()
T	selectorType(SelectorSettings.SelectorType selectorType)
T	single() Specify if only one item can be selected.

Methods inherited from class com.jalios.jcms.taglib.settings.BasicSettings

addOption, append, autofocus, clearOption, clone, css, dataAttribute, dataAttributes, disable, getOption, getOptionNames, getThis, htmlAttributes, htmlAttributes, id, isChannelReady, maxLength, merge, name, onChange, onFocusOut, placeholder, prepend, readonly, removeOption, require, showLanguageChooser, sortSet, toStringArray, toStringArray, toStringArray, toStringArray, toStringArray, trigger, value

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jalios.jcms.taglib.settings.ControlSettings

getType

Field Detail

SELECTOR_TYPE

public static final java.lang.String SELECTOR_TYPE

See Also:

Constant Field Values

ENUM_VALUES

public static final java.lang.String ENUM_VALUES

See Also:

Constant Field Values

ENUM_LABELS

public static final java.lang.String ENUM_LABELS

See Also:

Constant Field Values

ENUM_LABEL_PREPENDS

public static final java.lang.String ENUM_LABEL_PREPENDS

See Also:

Constant Field Values

ENUM_LABEL_APPENDS

public static final java.lang.String ENUM_LABEL_APPENDS

See Also:

Constant Field Values

INLINE

public static final java.lang.String INLINE

See Also:

Constant Field Values

MULTIPLE

public static final java.lang.String MULTIPLE

See Also:

Constant Field Values

REQUIRED

public static final java.lang.String REQUIRED

See Also:

Constant Field Values

SELECT_ITEM_EMPTY_VALUE

public static final java.lang.String SELECT_ITEM_EMPTY_VALUE

See Also:

Constant Field Values

Constructor Detail

SelectorSettings

public SelectorSettings()

Method Detail

selectorType

public T selectorType(SelectorSettings.SelectorType selectorType)

chooser

public T chooser()

select

public T select()

checkbox

public T checkbox()

radio

public T radio()

enumValues

public T enumValues(java.lang.Object[] enumValues)

enumValues

public T enumValues(java.util.Collection<?> enumValues)

enumValues

public T enumValues(java.lang.Object enumValue,
           java.lang.Object... otherEnumValues)

enumLabels

public T enumLabels(java.lang.String[] enumLabels)

enumLabels

public T enumLabels(java.util.Collection<java.lang.String> enumLabels)

enumLabels

public T enumLabels(java.lang.String enumLabel,
           java.lang.String... otherEnumLabels)

enumLabelPreprends

public T enumLabelPreprends(java.lang.String[] enumLabelPrepends)

enumLabelPreprends

public T enumLabelPreprends(java.util.Collection<java.lang.String> enumLabelPrepends)

enumLabelPreprends

public T enumLabelPreprends(java.lang.String enumLabelPrepend,
                   java.lang.String... otherEnumLabelPrepends)

enumLabelAppends

public T enumLabelAppends(java.lang.String[] enumLabelAppends)

enumLabelAppends

public T enumLabelAppends(java.util.Collection<java.lang.String> enumLabelAppends)

enumLabelAppends

public T enumLabelAppends(java.lang.String enumLabelAppend,
                 java.lang.String... otherEnumLabelAppends)

inline

public T inline()

disableInline

public T disableInline()

multiple

public T multiple()

Specify whether multiple items can be selected.

This methods is only used for the select fields (select()) and chooser fields (chooser()). If this method is used for other selector types (radio(), checkbox()), it will have no effect.

When the selector is defined as 'chooser' (chooser()), this method allows to have multiple values in the same field :
Example :

 
 <jalios:field name="myfield" label="Multiple categories in one input" value='<%= Util.join(selectedCategoryIds, " ") %>'>
   <jalios:control settings='<%= new CategorySettings().multiple() %>' />
 </jalios:field>
 
 

Returns:

a reference to this object - used to chain calls

See Also:

SelectorSettings#SelectorType, selectorType(SelectorType), radio(), checkbox(), select(), chooser()

single

public T single()

Specify if only one item can be selected.

This methods is only used for the select fields (select()) and chooser fields (chooser()). If this method is used for other selector types (radio(), checkbox()), it will have no effect.

Returns:

a reference to this object - used to chain calls

See Also:

SelectorSettings#SelectorType, selectorType(SelectorType), radio(), checkbox(), select(), chooser()

required

public T required()

resolveOptions

public void resolveOptions(TypeFieldEntry tfe)

Description copied from interface: ControlSettings

Set options from the specified TypeFieldEntry.

Specified by:

resolveOptions in interface ControlSettings

Overrides:

resolveOptions in class BasicSettings<T extends SelectorSettings<T>>

Parameters:

tfe - TypeFieldEntry