Package org.silverpeas.core.html.plugin

Class UserGroupSelectProducer

java.lang.Object

org.silverpeas.core.html.plugin.AbstractPluginInitializationProducer

org.silverpeas.core.html.plugin.UserGroupSelectProducer

public class UserGroupSelectProducer
extends AbstractPluginInitializationProducer

A producer of HTML data necessary to initialize the UserGroupSelect plugin on the WEB browser. The plugin is available under SupportedWebPlugin.Constants.LISTOFUSERSANDGROUPS.

Author:

silveryocha

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UserGroupSelectProducer.SelectionType

Constructor Summary

Constructors

Constructor	Description
UserGroupSelectProducer()

Method Summary

Modifier and Type	Method	Description
UserGroupSelectProducer	filterOnComponentId(String id)
UserGroupSelectProducer	filterOnRoles(String... roles)
protected String	getDependencies()
UserGroupSelectProducer	hidden(boolean hidden)
UserGroupSelectProducer	mandatory(boolean mandatory)
UserGroupSelectProducer	multiple(boolean multiple)
UserGroupSelectProducer	readOnly(boolean readOnly)
UserGroupSelectProducer	selectionOf(UserGroupSelectProducer.SelectionType selectionType)
static UserGroupSelectProducer	withContainerId(String id)	Initializing the producer with the most important data.
UserGroupSelectProducer	withGroupIds(String... ids)
UserGroupSelectProducer	withGroupInputName(String inputName)
UserGroupSelectProducer	withRemoveButtonLabel(String label)
UserGroupSelectProducer	withUserIds(String... ids)
UserGroupSelectProducer	withUserInputName(String inputName)
UserGroupSelectProducer	withUserPanelButtonLabel(String label)

Methods inherited from class org.silverpeas.core.html.plugin.AbstractPluginInitializationProducer

addOption, addOption, addOption, addOption, booleanValue, getUserLanguage, numericValue, produce, stringValue, withJsInstanceVar, withUserLanguage

Methods inherited from class java.lang.Object

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

Constructor Detail

UserGroupSelectProducer

public UserGroupSelectProducer()

Method Detail

withContainerId

public static UserGroupSelectProducer withContainerId(String id)

Initializing the producer with the most important data.

Parameters:

id - the identifier of the container which the plugin will fill.

Returns:

the new instance of the producer.

withUserInputName

public UserGroupSelectProducer withUserInputName(String inputName)

withGroupInputName

public UserGroupSelectProducer withGroupInputName(String inputName)

selectionOf

public UserGroupSelectProducer selectionOf(UserGroupSelectProducer.SelectionType selectionType)

multiple

public UserGroupSelectProducer multiple(boolean multiple)

readOnly

public UserGroupSelectProducer readOnly(boolean readOnly)

hidden

public UserGroupSelectProducer hidden(boolean hidden)

mandatory

public UserGroupSelectProducer mandatory(boolean mandatory)

withUserIds

public UserGroupSelectProducer withUserIds(String... ids)

withGroupIds

public UserGroupSelectProducer withGroupIds(String... ids)

filterOnComponentId

public UserGroupSelectProducer filterOnComponentId(String id)

filterOnRoles

public UserGroupSelectProducer filterOnRoles(String... roles)

withUserPanelButtonLabel

public UserGroupSelectProducer withUserPanelButtonLabel(String label)

withRemoveButtonLabel

public UserGroupSelectProducer withRemoveButtonLabel(String label)

getDependencies

protected String getDependencies()

Specified by:

getDependencies in class AbstractPluginInitializationProducer