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<CategoryTreeSettings>
,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.SelectMode, SelectorSettings.SelectorType
-
-
Field Summary
Fields Modifier and Type Field 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
ENABLE_SEARCH, ENUM_DATA_ATTRIBUTES, ENUM_LABEL_APPENDS, ENUM_LABEL_PREPENDS, ENUM_LABELS, ENUM_VALUES, INLINE, MULTIPLE, REQUIRED, SELECT_ITEM_EMPTY_VALUE, SELECT_ITEM_EMPTY_VALUE_LABEL, SELECTOR_TYPE
-
Fields inherited from class com.jalios.jcms.taglib.settings.BasicSettings
APPEND, ARIA_ATTR_PREFIX, ARIA_ATTRIBUTES, AUTOFOCUS, CLEAR_BUTTON, CSS, DATA_ATTR_PREFIX, DATA_ATTRIBUTES, DISABLED, HIDE_CLEAR_BUTTON, HTML_ATTRIBUTES, ID, LANGUAGE_CHOOSER, MAX_LENGTH, NAME, PLACEHOLDER, PREPEND, READONLY, TITLE, TRIGGER_ACTION, TRIGGER_EVENT, VALUE
-
-
Constructor Summary
Constructors Constructor Description CategoryTreeSettings()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description CategoryTreeSettings
checked(Category[] categories)
Specify the categories that are checked in the tree.CategoryTreeSettings
checked(Category category, Category... otherCategories)
Specify the categories that are checked in the tree.CategoryTreeSettings
checked(java.lang.String[] categoryIds)
Specify the categories that are checked in the tree.CategoryTreeSettings
checked(java.lang.String categoryId, java.lang.String... otherCategoryIds)
Specify the categories that are checked in the tree.CategoryTreeSettings
checked(java.util.Collection<Category> categories)
Specify the categories that are checked in the tree.CategoryTreeSettings
decorator(TreeViewDecorator decorator)
Add aTreeViewDecorator
implementation to override the list item renderer.CategoryTreeSettings
disableDragdrop()
Disable the drag'n'drop categories from the tree.CategoryTreeSettings
disableSearch()
Disable the category tree search field.CategoryTreeSettings
exactRootCategories()
Do not resolve Parent categories when there are multiple defined root categories that can potentially be in different branches.static java.util.Set<Category>
getOtherCategorySet(java.util.Set publicationCategories, java.util.Set<Category> wsRootSet)
protected CategoryTreeSettings
getThis()
Returns the exact type of the this reference.
It's a way to recover the type of thethis
object in a class hierarchy (cf.CategoryTreeSettings
hideCtxMenu()
Disable the category context menu.CategoryTreeSettings
highlighted(Category[] categories)
Specify the categories that are highlighted in the tree.CategoryTreeSettings
highlighted(Category category, Category... otherCategories)
Specify the categories that are highlighted in the tree.CategoryTreeSettings
highlighted(java.lang.String[] categoryIds)
Specify the categories that are highlighted in the tree.CategoryTreeSettings
highlighted(java.lang.String categoryId, java.lang.String... otherCategoryIds)
Specify the categories that are highlighted in the tree.CategoryTreeSettings
highlighted(java.util.Collection<Category> categories)
Specify the categories that are highlighted in the tree.CategoryTreeSettings
level(int level)
Specify the depth level up to which the tree is open.CategoryTreeSettings
opened(Category[] categories)
Specify the categories that are displayed open in the tree.CategoryTreeSettings
opened(Category category, Category... otherCategories)
Specify the categories that are displayed open in the tree.CategoryTreeSettings
opened(java.lang.String[] categoryIds)
Specify the categories that are displayed open in the tree.CategoryTreeSettings
opened(java.lang.String categoryId, java.lang.String... otherCategoryIds)
Specify the categories that are displayed open in the tree.CategoryTreeSettings
opened(java.util.Collection<Category> categories)
Specify the categories that are displayed open in the tree.CategoryTreeSettings
removed(Category[] categories)
Specify the categories that are removed from the tree.CategoryTreeSettings
removed(Category category, Category... otherCategories)
Specify the categories that are removed from the tree.CategoryTreeSettings
removed(java.lang.String[] categoryIds)
Specify the categories that are removed from the tree.CategoryTreeSettings
removed(java.lang.String categoryId, java.lang.String... otherCategoryIds)
Specify the categories that are removed from the tree.CategoryTreeSettings
removed(java.util.Collection<Category> categories)
Specify the categories that are removed from the tree.void
resolveOptions(TypeFieldEntry tfe)
Set options from the specifiedTypeFieldEntry
.CategoryTreeSettings
retained(Category[] categories)
Specify the categories that are retained in the tree.CategoryTreeSettings
retained(Category category, Category... otherCategories)
Specify the categories that are retained in the tree.CategoryTreeSettings
retained(java.lang.String[] categoryIds)
Specify the categories that are retained in the tree.CategoryTreeSettings
retained(java.lang.String categoryId, java.lang.String... otherCategoryIds)
Specify the categories that are retained in the tree.CategoryTreeSettings
retained(java.util.Collection<Category> categories)
Specify the categories that are retained in the tree.CategoryTreeSettings
showPortalIcon()
Display the "Portal" icon on the categories associated with a Portal.CategoryTreeSettings
showRightsIcon()
Show icons representing the rights on the categories.CategoryTreeSettings
showWorkspaceIcon()
Show the "Workspace" icon on the categories associated with a Workspace.static boolean
useTree(AbstractCategorySettings settings, java.lang.String[] fieldValuesArray)
Returns true if keyword should be used instead of tree display, to avoid performance issues when a big tree with a lot of categories is displayed within the browser.-
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, emptyValueLabel, enumDataAttribute, enumLabelAppends, enumLabelAppends, enumLabelAppends, enumLabelPreprends, enumLabelPreprends, enumLabelPreprends, enumLabels, enumLabels, enumLabels, enumValues, enumValues, enumValues, inline, multiple, radio, required, select, select, selectorType, single
-
Methods inherited from class com.jalios.jcms.taglib.settings.BasicSettings
addOption, append, aria, aria, autofocus, clearOption, css, dataAttribute, dataAttributes, disable, getOptionNames, htmlAttributes, htmlAttributes, id, isChannelReady, maxLength, merge, name, onChange, onFocusOut, placeholder, prepend, readonly, removeOption, require, showLanguageChooser, sortSet, title, toStringArray, toStringArray, toStringArray, toStringArray, toStringArray, trigger, value
-
-
-
-
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
-
-
Method Detail
-
getThis
protected CategoryTreeSettings getThis()
Description copied from class:BasicSettings
Returns the exact type of the this reference.
It's a way to recover the type of thethis
object in a class hierarchy (cf. getThis "trick").- Specified by:
getThis
in classBasicSettings<CategoryTreeSettings>
- Returns:
- The exact type of the this reference
-
resolveOptions
public void resolveOptions(TypeFieldEntry tfe)
Description copied from interface:ControlSettings
Set options from the specifiedTypeFieldEntry
.- Specified by:
resolveOptions
in interfaceControlSettings<CategoryTreeSettings>
- Overrides:
resolveOptions
in classAbstractCategorySettings<CategoryTreeSettings>
- Parameters:
tfe
-TypeFieldEntry
-
opened
public CategoryTreeSettings opened(java.lang.String[] categoryIds)
Specify the categories that are displayed open in the tree.- Parameters:
categoryIds
- Array ofCategory
IDs- Returns:
- a reference to this object - used to chain calls
-
opened
public CategoryTreeSettings opened(Category[] categories)
Specify the categories that are displayed open in the tree.- Parameters:
categories
- array ofCategory
objects- Returns:
- a reference to this object - used to chain calls
- See Also:
opened(String[])
-
opened
public CategoryTreeSettings opened(java.util.Collection<Category> categories)
Specify the categories that are displayed open in the tree.- Parameters:
categories
- Collection ofCategory
objects- Returns:
- a reference to this object - used to chain calls
- See Also:
opened(Category[])
-
opened
public CategoryTreeSettings opened(Category category, Category... otherCategories)
Specify the categories that are displayed open in the tree.- Parameters:
category
- The first category openotherCategories
- The other categories open- Returns:
- a reference to this object - used to chain calls
- See Also:
opened(String[])
-
opened
public CategoryTreeSettings opened(java.lang.String categoryId, java.lang.String... otherCategoryIds)
Specify the categories that are displayed open in the tree.- Parameters:
categoryId
- The first ID of the category openotherCategoryIds
- The other IDs of the categories open- Returns:
- a reference to this object - used to chain calls
- See Also:
opened(String[])
-
checked
public CategoryTreeSettings checked(java.lang.String[] categoryIds)
Specify the categories that are checked in the tree.- Parameters:
categoryIds
- Array ofCategory
IDs- Returns:
- a reference to this object - used to chain calls
-
checked
public CategoryTreeSettings checked(Category[] categories)
Specify the categories that are checked in the tree.- Parameters:
categories
- Array ofCategory
objects- Returns:
- a reference to this object - used to chain calls
- See Also:
checked(String[])
-
checked
public CategoryTreeSettings checked(java.util.Collection<Category> categories)
Specify the categories that are checked in the tree.- Parameters:
categories
- Collection ofCategory
objects- Returns:
- a reference to this object - used to chain calls
- See Also:
checked(Category[])
-
checked
public CategoryTreeSettings checked(Category category, Category... otherCategories)
Specify the categories that are checked in the tree.- Parameters:
category
- The first category checkedotherCategories
- The other categories checked- Returns:
- a reference to this object - used to chain calls
- See Also:
checked(String[])
-
checked
public CategoryTreeSettings checked(java.lang.String categoryId, java.lang.String... otherCategoryIds)
Specify the categories that are checked in the tree.- Parameters:
categoryId
- The first ID of category checkedotherCategoryIds
- The other IDs of categories checked- Returns:
- a reference to this object - used to chain calls
- See Also:
checked(String[])
-
highlighted
public CategoryTreeSettings highlighted(java.lang.String[] categoryIds)
Specify the categories that are highlighted in the tree.- Parameters:
categoryIds
- Array ofCategory
IDs- Returns:
- a reference to this object - used to chain calls
-
highlighted
public CategoryTreeSettings highlighted(Category[] categories)
Specify the categories that are highlighted in the tree.- Parameters:
categories
- Array ofCategory
objects- Returns:
- a reference to this object - used to chain calls
- See Also:
highlighted(String[])
-
highlighted
public CategoryTreeSettings highlighted(java.util.Collection<Category> categories)
Specify the categories that are highlighted in the tree.- Parameters:
categories
- Collection ofCategory
objects- Returns:
- a reference to this object - used to chain calls
- See Also:
highlighted(Category[])
-
highlighted
public CategoryTreeSettings highlighted(Category category, Category... otherCategories)
Specify the categories that are highlighted in the tree.- Parameters:
category
- The first category highlightedotherCategories
- The other categories highlighted- Returns:
- a reference to this object - used to chain calls
- See Also:
highlighted(String[])
-
highlighted
public CategoryTreeSettings highlighted(java.lang.String categoryId, java.lang.String... otherCategoryIds)
Specify the categories that are highlighted in the tree.- Parameters:
categoryId
- The first ID of category highlightedotherCategoryIds
- The other IDs of categories highlighted- Returns:
- a reference to this object - used to chain calls
- See Also:
highlighted(String[])
-
removed
public CategoryTreeSettings removed(java.lang.String[] categoryIds)
Specify the categories that are removed from the tree.- Parameters:
categoryIds
- Array ofCategory
IDs- Returns:
- a reference to this object - used to chain calls
-
removed
public CategoryTreeSettings removed(Category[] categories)
Specify the categories that are removed from the tree.- Parameters:
categories
- Array ofCategory
objects- Returns:
- a reference to this object - used to chain calls
- See Also:
removed(String[])
-
removed
public CategoryTreeSettings removed(java.util.Collection<Category> categories)
Specify the categories that are removed from the tree.- Parameters:
categories
- Collection ofCategory
objects- Returns:
- a reference to this object - used to chain calls
- See Also:
removed(Category[])
-
removed
public CategoryTreeSettings removed(Category category, Category... otherCategories)
Specify the categories that are removed from the tree.- Parameters:
category
- The first category removedotherCategories
- The other categories removed- Returns:
- a reference to this object - used to chain calls
- See Also:
removed(String[])
-
removed
public CategoryTreeSettings removed(java.lang.String categoryId, java.lang.String... otherCategoryIds)
Specify the categories that are removed from the tree.- Parameters:
categoryId
- The first ID of category removedotherCategoryIds
- The other IDs of categories removed- Returns:
- a reference to this object - used to chain calls
- See Also:
removed(String[])
-
retained
public CategoryTreeSettings retained(java.lang.String[] categoryIds)
Specify the categories that are retained in the tree.- Parameters:
categoryIds
- Array ofCategory
IDs- Returns:
- a reference to this object - used to chain calls
-
retained
public CategoryTreeSettings retained(Category[] categories)
Specify the categories that are retained in the tree.- Parameters:
categories
- Array ofCategory
objects- Returns:
- a reference to this object - used to chain calls
- See Also:
retained(String[])
-
retained
public CategoryTreeSettings retained(java.util.Collection<Category> categories)
Specify the categories that are retained in the tree.- Parameters:
categories
- Collection ofCategory
objects- Returns:
- a reference to this object - used to chain calls
- See Also:
retained(Category[])
-
retained
public CategoryTreeSettings retained(Category category, Category... otherCategories)
Specify the categories that are retained in the tree.- Parameters:
category
- The first category retainedotherCategories
- The other categories retained- Returns:
- a reference to this object - used to chain calls
- See Also:
retained(String[])
-
retained
public CategoryTreeSettings retained(java.lang.String categoryId, java.lang.String... otherCategoryIds)
Specify the categories that are retained in the tree.- Parameters:
categoryId
- The first ID of category retainedotherCategoryIds
- The other IDs of categories retained- Returns:
- a reference to this object - used to chain calls
- See Also:
retained(String[])
-
level
public CategoryTreeSettings level(int level)
Specify the depth level up to which the tree is open.- Parameters:
level
- The depth level- Returns:
- a reference to this object - used to chain calls
-
disableDragdrop
public CategoryTreeSettings disableDragdrop()
Disable the drag'n'drop categories from the tree.- Returns:
- a reference to this object - used to chain calls
-
hideCtxMenu
public CategoryTreeSettings hideCtxMenu()
Disable the category context menu.- Returns:
- a reference to this object - used to chain calls
-
disableSearch
public CategoryTreeSettings disableSearch()
Disable the category tree search field.- Returns:
- a reference to this object - used to chain calls
-
showRightsIcon
public CategoryTreeSettings showRightsIcon()
Show icons representing the rights on the categories.- Returns:
- a reference to this object - used to chain calls
-
showWorkspaceIcon
public CategoryTreeSettings showWorkspaceIcon()
Show the "Workspace" icon on the categories associated with a Workspace.- Returns:
- a reference to this object - used to chain calls
-
showPortalIcon
public CategoryTreeSettings showPortalIcon()
Display the "Portal" icon on the categories associated with a Portal.- Returns:
- a reference to this object - used to chain calls
-
exactRootCategories
public CategoryTreeSettings exactRootCategories()
Do not resolve Parent categories when there are multiple defined root categories that can potentially be in different branches.- Returns:
- a reference to this object - used to chain calls
-
decorator
public CategoryTreeSettings decorator(TreeViewDecorator decorator)
Add aTreeViewDecorator
implementation to override the list item renderer.- Parameters:
decorator
-TreeViewDecorator
- Returns:
- a reference to this object - used to chain calls
-
useTree
public static boolean useTree(AbstractCategorySettings settings, java.lang.String[] fieldValuesArray)
Returns true if keyword should be used instead of tree display, to avoid performance issues when a big tree with a lot of categories is displayed within the browser.- Parameters:
settings
- theAbstractCategorySettings
- Returns:
- true if keyword should be used instead of tree display
-
-