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.SelectMode, SelectorSettings.SelectorType
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
FILTER
static java.lang.String
GROUP
-
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 MemberSettings()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MemberSettings
filter(MemberSettings.MemberFilter filter, MemberSettings.MemberFilter... otherFilters)
Specify theMemberSettings.MemberFilter
s to filter the members according to certain criteria (in database, admin account, ...).MemberSettings
filter(java.lang.String filter, java.lang.String... otherFilters)
Specify theMemberSettings.MemberFilter
s to filter the members according to certain criteria (in database, admin account, ...).
The String in parameter are resolved withMemberSettings.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 currentControlSettings
protected MemberSettings
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.ControlType
getType()
Returns theControlType
related to the currentControlSettings
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)
SpecifyGroup
IDs to filter members on these groups.MemberSettings
group(java.lang.String groupId, java.lang.String... otherGroupIds)
SpecifyGroup
IDs to filter members on these groups.MemberSettings
group(java.util.Collection<Group> groups)
Specify groups to filter members on these groups.void
resolveOptions(TypeFieldEntry tfe)
Set options from the specifiedTypeFieldEntry
.-
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, select, select, selectorType, single
-
Methods inherited from class com.jalios.jcms.taglib.settings.BasicSettings
addOption, append, aria, aria, autofocus, clearOption, clone, 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
-
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
-
-
Method Detail
-
getType
public ControlType getType()
Description copied from interface:ControlSettings
Returns theControlType
related to the currentControlSettings
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 thethis
object in a class hierarchy (cf. getThis "trick").- Specified by:
getThis
in classBasicSettings<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 currentControlSettings
- Specified by:
getDataClass
in classAbstractDataSettings<MemberSettings>
- Returns:
- The
Data
class
-
resolveOptions
public void resolveOptions(TypeFieldEntry tfe)
Description copied from interface:ControlSettings
Set options from the specifiedTypeFieldEntry
.- Specified by:
resolveOptions
in interfaceControlSettings<MemberSettings>
- Overrides:
resolveOptions
in classSelectorSettings<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 classAbstractChooserSettings<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 classAbstractDataSettings<MemberSettings>
- Parameters:
customOptionMap
- Extra chooser options forwarded by the optionChooserConstants.EXTRA_CHOOSER_OPTION
and appended to the query string- Returns:
String
representing the options as query string
-
group
public MemberSettings group(java.lang.String[] groupIds)
SpecifyGroup
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 ofGroup
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 ofGroup
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 groupotherGroups
- 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)
SpecifyGroup
IDs to filter members on these groups.
-
filter
public MemberSettings filter(MemberSettings.MemberFilter filter, MemberSettings.MemberFilter... otherFilters)
Specify theMemberSettings.MemberFilter
s to filter the members according to certain criteria (in database, admin account, ...).- Parameters:
filter
- the firstMemberSettings.MemberFilter
objectotherFilters
- The otherMemberSettings.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 theMemberSettings.MemberFilter
s to filter the members according to certain criteria (in database, admin account, ...).
The String in parameter are resolved withMemberSettings.MemberFilter.getFilter(String)
.- Parameters:
filter
- the first filterotherFilters
- the other filter- Returns:
- a reference to this object - used to chain calls
-
-