com.jalios.jcms.taglib.settings.impl

Class CategoryTreeSettings

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<CategoryTreeSettings>

com.jalios.jcms.taglib.settings.impl.CategoryTreeSettings

All Implemented Interfaces:

ControlSettings, java.lang.Cloneable

public class CategoryTreeSettings
extends AbstractCategorySettings<CategoryTreeSettings>

Category tree Settings.

Author:

Nicolas Dos Santos

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	CHECKED_CATEGORIES
static java.lang.String	CTXMENU
static java.lang.String	DECORATOR
static java.lang.String	DRAGDROP
static java.lang.String	EXACT_ROOT
static java.lang.String	HIGHLIGHTED_CATEGORIES
static java.lang.String	LEVEL
static java.lang.String	OPENED_CATEGORIES
static java.lang.String	PORTAL_ICON
static java.lang.String	REMOVED_CATEGORIES
static java.lang.String	RETAINED_CATEGORIES
static java.lang.String	RIGHTS_ICON
static java.lang.String	WORKSPACE_ICON

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

CATEGORY_FILTER, DISPLAY_ROOTS, LIVE_CREATION, ORIGINAL_ROOT_CATEGORY, ROOT_CATEGORIES, SEARCH, SELECTABLE, 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
CategoryTreeSettings()

Method Summary

Methods

Modifier and Type	Method and Description
CategoryTreeSettings	checked(Category[] categories)
CategoryTreeSettings	checked(Category category, Category... otherCategories)
CategoryTreeSettings	checked(java.util.Collection<Category> categories)
CategoryTreeSettings	checked(java.lang.String[] categoryIds)
CategoryTreeSettings	checked(java.lang.String categoryId, java.lang.String... otherCategoryIds)
CategoryTreeSettings	decorator(TreeViewDecorator decorator) Add a TreeViewDecorator implementation to override the list item renderer.
CategoryTreeSettings	disableDragdrop()
CategoryTreeSettings	disableSearch()
CategoryTreeSettings	exactRootCategories() Do not resolve Parent categories when there are multiple defined root categories that can potentially be in different branches.
protected CategoryTreeSettings	getThis()
CategoryTreeSettings	hideCtxMenu()
CategoryTreeSettings	highlighted(Category[] categories)
CategoryTreeSettings	highlighted(Category category, Category... otherCategories)
CategoryTreeSettings	highlighted(java.util.Collection<Category> categories)
CategoryTreeSettings	highlighted(java.lang.String[] categoryIds)
CategoryTreeSettings	highlighted(java.lang.String categoryId, java.lang.String... otherCategoryIds)
CategoryTreeSettings	level(int level)
CategoryTreeSettings	opened(Category[] categories)
CategoryTreeSettings	opened(Category category, Category... otherCategories)
CategoryTreeSettings	opened(java.util.Collection<Category> categories)
CategoryTreeSettings	opened(java.lang.String[] categoryIds)
CategoryTreeSettings	opened(java.lang.String categoryId, java.lang.String... otherCategoryIds)
CategoryTreeSettings	removed(Category[] categories)
CategoryTreeSettings	removed(Category category, Category... otherCategories)
CategoryTreeSettings	removed(java.util.Collection<Category> categories)
CategoryTreeSettings	removed(java.lang.String[] categoryIds)
CategoryTreeSettings	removed(java.lang.String categoryId, java.lang.String... otherCategoryIds)
void	resolveOptions(TypeFieldEntry tfe) Set options from the specified TypeFieldEntry.
CategoryTreeSettings	retained(Category[] categories)
CategoryTreeSettings	retained(Category category, Category... otherCategories)
CategoryTreeSettings	retained(java.util.Collection<Category> categories)
CategoryTreeSettings	retained(java.lang.String[] categoryIds)
CategoryTreeSettings	retained(java.lang.String categoryId, java.lang.String... otherCategoryIds)
CategoryTreeSettings	showPortalIcon()
CategoryTreeSettings	showRightsIcon()
CategoryTreeSettings	showWorkspaceIcon()

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

clone, disableLiveCreation, displayRoots, filter, filter, getChooserName, getChooserOption, getDataClass, getOption, getType, resolveRootCategories, root, root, root, root, root, 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, 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

OPENED_CATEGORIES

public static final java.lang.String OPENED_CATEGORIES

See Also:

Constant Field Values

CHECKED_CATEGORIES

public static final java.lang.String CHECKED_CATEGORIES

See Also:

Constant Field Values

HIGHLIGHTED_CATEGORIES

public static final java.lang.String HIGHLIGHTED_CATEGORIES

See Also:

Constant Field Values

REMOVED_CATEGORIES

public static final java.lang.String REMOVED_CATEGORIES

See Also:

Constant Field Values

RETAINED_CATEGORIES

public static final java.lang.String RETAINED_CATEGORIES

See Also:

Constant Field Values

LEVEL

public static final java.lang.String LEVEL

See Also:

Constant Field Values

DRAGDROP

public static final java.lang.String DRAGDROP

See Also:

Constant Field Values

CTXMENU

public static final java.lang.String CTXMENU

See Also:

Constant Field Values

RIGHTS_ICON

public static final java.lang.String RIGHTS_ICON

See Also:

Constant Field Values

WORKSPACE_ICON

public static final java.lang.String WORKSPACE_ICON

See Also:

Constant Field Values

PORTAL_ICON

public static final java.lang.String PORTAL_ICON

See Also:

Constant Field Values

EXACT_ROOT

public static final java.lang.String EXACT_ROOT

See Also:

Constant Field Values

DECORATOR

public static final java.lang.String DECORATOR

See Also:

Constant Field Values

Constructor Detail

CategoryTreeSettings

public CategoryTreeSettings()

Method Detail

getThis

protected CategoryTreeSettings getThis()

Specified by:

getThis in class BasicSettings<CategoryTreeSettings>

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 AbstractCategorySettings<CategoryTreeSettings>

Parameters:

tfe - TypeFieldEntry

opened

public CategoryTreeSettings opened(java.lang.String[] categoryIds)

opened

public CategoryTreeSettings opened(Category[] categories)

opened

public CategoryTreeSettings opened(java.util.Collection<Category> categories)

opened

public CategoryTreeSettings opened(Category category,
                          Category... otherCategories)

opened

public CategoryTreeSettings opened(java.lang.String categoryId,
                          java.lang.String... otherCategoryIds)

checked

public CategoryTreeSettings checked(java.lang.String[] categoryIds)

checked

public CategoryTreeSettings checked(Category[] categories)

checked

public CategoryTreeSettings checked(java.util.Collection<Category> categories)

checked

public CategoryTreeSettings checked(Category category,
                           Category... otherCategories)

checked

public CategoryTreeSettings checked(java.lang.String categoryId,
                           java.lang.String... otherCategoryIds)

highlighted

public CategoryTreeSettings highlighted(java.lang.String[] categoryIds)

highlighted

public CategoryTreeSettings highlighted(Category[] categories)

highlighted

public CategoryTreeSettings highlighted(java.util.Collection<Category> categories)

highlighted

public CategoryTreeSettings highlighted(Category category,
                               Category... otherCategories)

highlighted

public CategoryTreeSettings highlighted(java.lang.String categoryId,
                               java.lang.String... otherCategoryIds)

removed

public CategoryTreeSettings removed(java.lang.String[] categoryIds)

removed

public CategoryTreeSettings removed(Category[] categories)

removed

public CategoryTreeSettings removed(java.util.Collection<Category> categories)

removed

public CategoryTreeSettings removed(Category category,
                           Category... otherCategories)

removed

public CategoryTreeSettings removed(java.lang.String categoryId,
                           java.lang.String... otherCategoryIds)

retained

public CategoryTreeSettings retained(java.lang.String[] categoryIds)

retained

public CategoryTreeSettings retained(Category[] categories)

retained

public CategoryTreeSettings retained(java.util.Collection<Category> categories)

retained

public CategoryTreeSettings retained(Category category,
                            Category... otherCategories)

retained

public CategoryTreeSettings retained(java.lang.String categoryId,
                            java.lang.String... otherCategoryIds)

level

public CategoryTreeSettings level(int level)

disableDragdrop

public CategoryTreeSettings disableDragdrop()

hideCtxMenu

public CategoryTreeSettings hideCtxMenu()

disableSearch

public CategoryTreeSettings disableSearch()

showRightsIcon

public CategoryTreeSettings showRightsIcon()

showWorkspaceIcon

public CategoryTreeSettings showWorkspaceIcon()

showPortalIcon

public CategoryTreeSettings showPortalIcon()

exactRootCategories

public CategoryTreeSettings exactRootCategories()

Do not resolve Parent categories when there are multiple defined root categories that can potentially be in different branches.

Returns:

current settings

decorator

public CategoryTreeSettings decorator(TreeViewDecorator decorator)

Add a TreeViewDecorator implementation to override the list item renderer.

Parameters:

decorator - TreeViewDecorator

Returns:

current settings