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

Class MemberSettings

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

com.jalios.jcms.taglib.settings.impl.MemberSettings

All Implemented Interfaces:

ControlSettings<MemberSettings>, java.lang.Cloneable

public class MemberSettings
extends AbstractDataSettings<MemberSettings>

Member Settings

Author:

Nicolas Dos Santos

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MemberSettings.MemberFilter	Enumeration of Member filters.

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	FILTER
static java.lang.String	GROUP
static java.lang.String	LUCENE

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

Method Summary

Modifier and Type	Method	Description
MemberSettings	filter(MemberSettings.MemberFilter filter, MemberSettings.MemberFilter... otherFilters)	Specify the MemberSettings.MemberFilters to filter the members according to certain criteria (in database, admin account, ...).
MemberSettings	filter(java.lang.String filter, java.lang.String... otherFilters)	Specify the MemberSettings.MemberFilters to filter the members according to certain criteria (in database, admin account, ...). The String in parameter are resolved with MemberSettings.MemberFilter.getFilter(String).
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 MemberSettings	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.
MemberSettings	group(Group[] groups)	Specify groups to filter members on these groups.
MemberSettings	group(Group group, Group... otherGroups)	Specify groups to filter members on these groups.
MemberSettings	group(java.lang.String[] groupIds)	Specify Group IDs to filter members on these groups.
MemberSettings	group(java.lang.String groupId, java.lang.String... otherGroupIds)	Specify Group IDs to filter members on these groups.
MemberSettings	group(java.util.Collection<Group> groups)	Specify groups to filter members on these groups.
MemberSettings	lucene()	Request that member query gets performed using lucene capabilities.
void	resolveOptions(TypeFieldEntry tfe)	Set options from the specified TypeFieldEntry.

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

GROUP

public static final java.lang.String GROUP

See Also:

Constant Field Values

FILTER

public static final java.lang.String FILTER

See Also:

Constant Field Values

LUCENE

public static final java.lang.String LUCENE

See Also:

Constant Field Values

Constructor Detail

MemberSettings

public MemberSettings()

Method Detail

getType

public ControlType getType()

Description copied from interface: ControlSettings

Returns the ControlType related to the current ControlSettings implementation.

Returns:

ControlType

getThis

protected MemberSettings 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<MemberSettings>

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

Returns:

The Data class

resolveOptions

public void resolveOptions(TypeFieldEntry tfe)

Description copied from interface: ControlSettings

Set options from the specified TypeFieldEntry.

Specified by:

resolveOptions in interface ControlSettings<MemberSettings>

Overrides:

resolveOptions in class SelectorSettings<MemberSettings>

Parameters:

tfe - TypeFieldEntry

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

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

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

lucene

public MemberSettings lucene()

Request that member query gets performed using lucene capabilities.

Returns:

a reference to this object - used to chain calls

group

public MemberSettings group(java.lang.String[] groupIds)

Specify Group IDs to filter members on these groups.

Parameters:

groupIds - Group IDs

Returns:

a reference to this object - used to chain calls

group

public MemberSettings group(Group[] groups)

Specify groups to filter members on these groups.

Parameters:

groups - Array of Group objects

Returns:

a reference to this object - used to chain calls

group

public MemberSettings group(java.util.Collection<Group> groups)

Specify groups to filter members on these groups.

Parameters:

groups - Collection of Group objects

Returns:

a reference to this object - used to chain calls

group

public MemberSettings group(Group group,
                            Group... otherGroups)

Specify groups to filter members on these groups.

Parameters:

group - the first group

otherGroups - The other groups

Returns:

a reference to this object - used to chain calls

group

public MemberSettings group(java.lang.String groupId,
                            java.lang.String... otherGroupIds)

Specify Group IDs to filter members on these groups.

Parameters:

groupId - The first Group ID

otherGroupIds - the other Group IDs

Returns:

a reference to this object - used to chain calls

filter

public MemberSettings filter(MemberSettings.MemberFilter filter,
                             MemberSettings.MemberFilter... otherFilters)

Specify the MemberSettings.MemberFilters to filter the members according to certain criteria (in database, admin account, ...).

Parameters:

filter - the first MemberSettings.MemberFilter object

otherFilters - The other MemberSettings.MemberFilter objects

Returns:

a reference to this object - used to chain calls

filter

public MemberSettings filter(java.lang.String filter,
                             java.lang.String... otherFilters)

Specify the MemberSettings.MemberFilters to filter the members according to certain criteria (in database, admin account, ...).
The String in parameter are resolved with MemberSettings.MemberFilter.getFilter(String).

Parameters:

filter - the first filter

otherFilters - the other filter

Returns:

a reference to this object - used to chain calls