com.jalios.jcms.taglib.settings

Class AbstractCategorySettings<T extends AbstractCategorySettings<T>>

java.lang.Object

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

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

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

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

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

All Implemented Interfaces:

ControlSettings, java.lang.Cloneable

Direct Known Subclasses:

CategorySettings, CategoryTreeSettings

public abstract class AbstractCategorySettings<T extends AbstractCategorySettings<T>>
extends AbstractDataSettings<T>

Nested Class Summary

Nested classes/interfaces inherited from class com.jalios.jcms.taglib.settings.SelectorSettings

SelectorSettings.SelectorType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CATEGORY_FILTER
static java.lang.String	DISPLAY_ROOTS
static java.lang.String	LIVE_CREATION
static java.lang.String	ORIGINAL_ROOT_CATEGORY If displayRoot == false, we must display the children categories.
static java.lang.String	ROOT_CATEGORIES
static java.lang.String	SEARCH
static java.lang.String	SELECTABLE
static java.lang.String	TREE

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

DATA_CLASS

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

ENUM_LABEL_APPENDS, ENUM_LABEL_PREPENDS, ENUM_LABELS, ENUM_VALUES, INLINE, MULTIPLE, REQUIRED, SELECT_ITEM_EMPTY_VALUE, 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
AbstractCategorySettings()

Method Summary

Methods

Modifier and Type	Method and Description
T	clone() Clone the current ControlSettings.
T	disableLiveCreation()
T	displayRoots(boolean displayRoots)
T	filter(CategoryFilter filter)
T	filter(java.lang.String filter)
protected java.lang.String	getChooserName()
protected java.lang.String	getChooserOption(java.util.Map<java.lang.String,java.lang.String[]> customOptionMap)
java.lang.Class<? extends Data>	getDataClass()
<V> V	getOption(java.lang.String optionName) Returns the value of the specified option.
ControlType	getType() Returns the ControlType related to the current ControlSettings implementation.
void	resolveOptions(TypeFieldEntry tfe) Set options from the specified TypeFieldEntry.
Category[]	resolveRootCategories() Returns the categories to display according to the 'displayRoots' attribute is true or false.
T	root(Category[] categories)
T	root(Category category, Category... otherCategories)
T	root(java.util.Collection<Category> categories)
T	root(java.lang.String[] categoryIds)
T	root(java.lang.String categoryId, java.lang.String... otherCategoryIds)
T	uncheckSelectable()

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

addAcChooserOption, addChooserOption, getAcChooserName, getAcChooserOption, getChooserIcon, getChooserTitle, popupHeight, popupWidth, superGetOption, useCurrentWorkspace, workspace, workspace

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

checkbox, chooser, disableInline, enumLabelAppends, enumLabelAppends, enumLabelAppends, enumLabelPreprends, enumLabelPreprends, enumLabelPreprends, enumLabels, enumLabels, enumLabels, enumValues, enumValues, enumValues, inline, multiple, radio, required, select, selectorType, single

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

addOption, append, autofocus, clearOption, css, dataAttribute, dataAttributes, disable, 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

Field Detail

ROOT_CATEGORIES

public static final java.lang.String ROOT_CATEGORIES

See Also:

Constant Field Values

DISPLAY_ROOTS

public static final java.lang.String DISPLAY_ROOTS

See Also:

Constant Field Values

CATEGORY_FILTER

public static final java.lang.String CATEGORY_FILTER

See Also:

Constant Field Values

SELECTABLE

public static final java.lang.String SELECTABLE

See Also:

Constant Field Values

LIVE_CREATION

public static final java.lang.String LIVE_CREATION

See Also:

Constant Field Values

TREE

public static final java.lang.String TREE

See Also:

Constant Field Values

SEARCH

public static final java.lang.String SEARCH

See Also:

Constant Field Values

ORIGINAL_ROOT_CATEGORY

public static final java.lang.String ORIGINAL_ROOT_CATEGORY

If displayRoot == false, we must display the children categories. If there is not, it displays an empty category tree. We need to display a message with the support of the right click to add new categories, but we don't have the root category information because treecatview tag has only one attribute 'collection' which is then empty. TODO The treecatview tag should have two attributes as in JCMS 8.x: rootSet and displayRoot

See Also:

Constant Field Values

Constructor Detail

AbstractCategorySettings

public AbstractCategorySettings()

Method Detail

getType

public ControlType getType()

Description copied from interface: ControlSettings

Returns the ControlType related to the current ControlSettings implementation.

Returns:

ControlType

getDataClass

public java.lang.Class<? extends Data> getDataClass()

Specified by:

getDataClass in class AbstractDataSettings<T extends AbstractCategorySettings<T>>

getOption

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

Description copied from interface: ControlSettings

Returns the value of the specified option.

Specified by:

getOption in interface ControlSettings

Overrides:

getOption in class AbstractDataSettings<T extends AbstractCategorySettings<T>>

Parameters:

optionName - Option name

Returns:

Option value

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 SelectorSettings<T extends AbstractCategorySettings<T>>

Parameters:

tfe - TypeFieldEntry

getChooserName

protected java.lang.String getChooserName()

Specified by:

getChooserName in class AbstractChooserSettings<T extends AbstractCategorySettings<T>>

getChooserOption

protected java.lang.String getChooserOption(java.util.Map<java.lang.String,java.lang.String[]> customOptionMap)

Specified by:

getChooserOption in class AbstractChooserSettings<T extends AbstractCategorySettings<T>>

clone

public T clone()
                                            throws java.lang.CloneNotSupportedException

Description copied from interface: ControlSettings

Clone the current ControlSettings.

Specified by:

clone in interface ControlSettings

Overrides:

clone in class BasicSettings<T extends AbstractCategorySettings<T>>

Returns:

the new cloned ControlSettings

Throws:

java.lang.CloneNotSupportedException

root

public T root(java.lang.String[] categoryIds)

root

public T root(Category[] categories)

root

public T root(java.util.Collection<Category> categories)

root

public T root(Category category,
     Category... otherCategories)

root

public T root(java.lang.String categoryId,
     java.lang.String... otherCategoryIds)

displayRoots

public T displayRoots(boolean displayRoots)

filter

public T filter(CategoryFilter filter)

filter

public T filter(java.lang.String filter)

uncheckSelectable

public T uncheckSelectable()

disableLiveCreation

public T disableLiveCreation()

resolveRootCategories

public Category[] resolveRootCategories()

Returns the categories to display according to the 'displayRoots' attribute is true or false. If 'displayRoots' is false, searches the children categories to display.

Returns:

array of Category