Package com.jalios.jcms.taglib.settings

Interface ControlSettings<T extends ControlSettings<T>>

Type Parameters:

T - Type of ControlSettings

All Superinterfaces:

java.lang.Cloneable

All Known Implementing Classes:

AbstractAreaSettings, AbstractCategorySettings, AbstractChooserSettings, AbstractDataSettings, AbstractTextChooserSettings, AbstractTextSettings, AclSettings, BasicSettings, BooleanSettings, CategorySettings, CategoryTreeSettings, ColorSettings, CountrySettings, DateSettings, DbRecordSettings, DefaultSettings, DurationSettings, EmailSettings, EnumerateSettings, FileSettings, GroupSettings, HiddenSettings, IconSettings, ImagePathSettings, LanguageSettings, MediaPathSettings, MediaSettings, MemberSettings, NumberSettings, PasswordSettings, PublicationSettings, QuerySettings, RichTextAreaSettings, SearchSettings, SelectorSettings, SelectSettings, SqlQuerySettings, TextAreaSettings, TextFieldSettings, TimeZoneSettings, TypeSettings, UrlSettings, WikiAreaSettings, WorkspaceSettings, WysiwygSettings

public interface ControlSettings<T extends ControlSettings<T>>
extends java.lang.Cloneable

Interface to provide the settings of a <jalios:control>.
The <jalios:control> tag provides the settings attribute that accepts an instance of ControlSettings.
A ControlSettings has options. An option is the combination of a name represented by a String and a value represented by an Object.

Author:

ndossantos

Method Summary

Modifier and Type	Method	Description
T	addOption(java.lang.String optionName, java.lang.Object optionValues)	Adds new option with the specified value(s).
T	clone()	Clone the current ControlSettings.
<V> V	getOption(java.lang.String optionName)	Returns the value of the specified option.
java.util.Collection<java.lang.String>	getOptionNames()	Returns the names of defined options for the current ControlSettings.
ControlType	getType()	Returns the ControlType related to the current ControlSettings implementation.
void	merge(ControlSettings<?> settings)	Merge the current ControlSettings options with the options of specified ControlSettings.
T	removeOption(java.lang.String optionName)	Removes the specified option.
void	resolveOptions(TypeFieldEntry tfe)	Set options from the specified TypeFieldEntry.

Method Detail

getType

ControlType getType()

Returns the ControlType related to the current ControlSettings implementation.

Returns:

ControlType

addOption

T addOption(java.lang.String optionName,
            java.lang.Object optionValues)

Adds new option with the specified value(s). If the given value is null, the option is removed.

Parameters:

optionName - Option name

optionValues - Option value(s)

Returns:

a reference to this object - used to chain calls

getOption

<V> V getOption(java.lang.String optionName)

Returns the value of the specified option.

Parameters:

optionName - Option name

Returns:

Option value

removeOption

T removeOption(java.lang.String optionName)

Removes the specified option.

Parameters:

optionName - Option name

Returns:

a reference to this object - used to chain calls

getOptionNames

java.util.Collection<java.lang.String> getOptionNames()

Returns the names of defined options for the current ControlSettings.

Returns:

Collection of String representing the option names

resolveOptions

void resolveOptions(TypeFieldEntry tfe)

Set options from the specified TypeFieldEntry.

Parameters:

tfe - TypeFieldEntry

merge

void merge(ControlSettings<?> settings)

Merge the current ControlSettings options with the options of specified ControlSettings.

Parameters:

settings - ControlSettings to be merged with the current ControlSettings

clone

T clone()
 throws java.lang.CloneNotSupportedException

Clone the current ControlSettings.

Returns:

the new cloned ControlSettings

Throws:

java.lang.CloneNotSupportedException