Package com.jalios.jcms.taglib.settings.impl

Class WorkspaceSettings

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

com.jalios.jcms.taglib.settings.impl.WorkspaceSettings

All Implemented Interfaces:

ControlSettings<WorkspaceSettings>, java.lang.Cloneable

public class WorkspaceSettings
extends AbstractDataSettings<WorkspaceSettings>

Workspace Settings

Author:

Nicolas Dos Santos

Nested Class Summary

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

SelectorSettings.SegmentedType, SelectorSettings.SelectMode, SelectorSettings.SelectorType

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	WORKSPACE

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, SEGMENTED_TYPE, SEGMENTED_TYPE_DEFAULT, SELECT_ITEM_EMPTY_VALUE, SELECT_ITEM_EMPTY_VALUE_LABEL, SELECTOR_TYPE, WRAPPER_CSS

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
WorkspaceSettings()

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	getChooserName()	Chooser name used by the databroker when there is a click event in the chooser button.
protected java.lang.String	getChooserOption(java.util.Map<java.lang.String,java.lang.String[]> customOptionMap)	Options used by the databroker when there is a click event in the chooser button.
java.lang.Class<? extends Data>	getDataClass()	Data class supported by the current ControlSettings
protected WorkspaceSettings	getThis()	Returns the exact type of the this reference. It's a way to recover the type of the this object in a class hierarchy (cf.
ControlType	getType()	Returns the ControlType related to the current ControlSettings implementation.
WorkspaceSettings	workspace(Workspace workspace)	Specify the Workspace on which the control is filtered.
WorkspaceSettings	workspace(java.lang.String workspaceId)	Specify the Workspace on which the control is filtered.

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

getOption

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

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

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, resolveOptions, segmented, select, select, selectorType, single, wrapperCss

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

addOption, append, aria, aria, autofocus, clearOption, clone, css, dataAttribute, 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

Methods inherited from class java.lang.Object

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

Field Detail

WORKSPACE

public static final java.lang.String WORKSPACE

See Also:

Constant Field Values

Constructor Detail

WorkspaceSettings

public WorkspaceSettings()

Method Detail

getType

public ControlType getType()

Description copied from interface: ControlSettings

Returns the ControlType related to the current ControlSettings implementation.

Returns:

ControlType

getThis

protected WorkspaceSettings getThis()

Description copied from class: BasicSettings

Returns the exact type of the this reference.
It's a way to recover the type of the this object in a class hierarchy (cf. getThis "trick").

Specified by:

getThis in class BasicSettings<WorkspaceSettings>

Returns:

The exact type of the this reference

getDataClass

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

Description copied from class: AbstractDataSettings

Data class supported by the current ControlSettings

Specified by:

getDataClass in class AbstractDataSettings<WorkspaceSettings>

Returns:

The Data class

getChooserName

protected java.lang.String getChooserName()

Description copied from class: AbstractChooserSettings

Chooser name used by the databroker when there is a click event in the chooser button.

Specified by:

getChooserName in class AbstractChooserSettings<WorkspaceSettings>

Returns:

The chooser name

See Also:

"/js/jalios/core/jalios-widget-chooser.js"

getChooserOption

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

Description copied from class: AbstractChooserSettings

Options used by the databroker when there is a click event in the chooser button.

Overrides:

getChooserOption in class AbstractDataSettings<WorkspaceSettings>

Parameters:

customOptionMap - Extra chooser options forwarded by the option ChooserConstants.EXTRA_CHOOSER_OPTION and appended to the query string

Returns:

String representing the options as query string

workspace

public WorkspaceSettings workspace(Workspace workspace)

Specify the Workspace on which the control is filtered.

Overrides:

workspace in class AbstractChooserSettings<WorkspaceSettings>

Parameters:

workspace - Workspace

Returns:

a reference to this object - used to chain calls

workspace

public WorkspaceSettings workspace(java.lang.String workspaceId)

Specify the Workspace on which the control is filtered.

Overrides:

workspace in class AbstractChooserSettings<WorkspaceSettings>

Parameters:

workspaceId - Workspace ID

Returns:

a reference to this object - used to chain calls