Package lumis.doui.control.principalpicker

Class PrincipalPickerControl

java.lang.Object

lumis.doui.control.Control

lumis.doui.control.DataControl

lumis.doui.control.DataBoundControl

lumis.doui.control.principalpicker.PrincipalPickerControl

All Implemented Interfaces:

java.util.Observer, javax.servlet.jsp.el.VariableResolver, IControl, IDataBoundControl, IDataControl, IRenderer

Direct Known Subclasses:

ServiceInstancePrincipalPickerControl

public class PrincipalPickerControl
extends DataBoundControl

Renders a control that allows the end user to select a principal. The list of principals may be limited to users or groups.

Example use: <control type="lum_principalPicker" id="principalId" showType="users"/> xml data available for xsl rendering: <control id="principalId" showType="users" type="lum_principalPicker"> <strings> <string id="STR_SELECT">Select</string> <string id="STR_CLEAR">Clear</string> </strings> <data> <principal> <principalId>00000000D00000000000000000000001</principalId> <shortId>admin</shortId> <name>Administrator</name> <type>1</type> <subtype>0</subtype> </principal> <openPopup><!--javascript--></openPopup> <updateScript><!--javascript--></updateScript> </data> </control>

Since:

4.1.1

Version:

$Revision$ $Date$

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	SHOW_ALL
protected static java.lang.String	SHOW_GROUPS
protected static java.lang.String	SHOW_USERS

Fields inherited from class lumis.doui.control.DataControl

FORCE_CASE_LOWER, FORCE_CASE_NONE, FORCE_CASE_UPPER, forceCase, requestParameterName, UNKNOWN_DATA_TYPE, value, valuePreviouslySet

Fields inherited from class lumis.doui.control.Control

childControls, controlContainer, controlDefinitionNode, controlResource, douiContext, hasValidatorSubControls, isValid, locale, ON_EVENT_CLOSE_WINDOW, ON_EVENT_LINK, ON_EVENT_POPUP_LINK_OR_RUNTIME_INTERFACE, ON_EVENT_POPUP_RUNTIME_INTERFACE, ON_EVENT_PROCESS_ACTION, ON_EVENT_RENDER_ACTION, ON_EVENT_REPLACE_INTERFACE, ON_EVENT_SCRIPT, ON_EVENT_VALIDATE, onEventScripts, PARAMETER_TYPE_FIRST_SELECTED, PARAMETER_TYPE_GET_VALUE, parentControl, resources, type, VALIDATION_SELECTED_MANY, VALIDATION_SELECTED_ONE

Constructor Summary

Constructors

Constructor	Description
PrincipalPickerControl()

Method Summary

Modifier and Type	Method	Description
void	buildSubControls()
protected IDouiDataType	createDataType()	Creates the data type to be used for this control.
protected boolean	fixedIdentifierRequired()
IResource	getControlResource()
protected IServiceInterfaceUrl	getPopupUrl()
protected java.lang.String	getSelectPrincipalFunctionName()	Returns the script function name for selecting a principal.
protected java.lang.Integer	getShowType()	Returns the type of principals be showed.
protected java.util.Map<java.lang.String,java.lang.String>	getStringsToLocalize()
protected java.lang.Class<? extends PrincipalDataType.Data>	getValueClass()	Returns the class the possible values of this control are assignable to.
void	init(org.w3c.dom.Node controlDefinitionNode, ControlContainer controlContainer, IControl parentControl)
void	setRenderData()

Methods inherited from class lumis.doui.control.DataBoundControl

autoAddDateTimeValueValidator, autoAddDoubleValueValidator, autoAddFileSizeValidator, autoAddIntegerValueValidator, autoAddLengthValidator, autoAddLongValueValidator, autoAddRequiredValueValidator, autoAddValidators, createConverter, getDataId, getFieldName, getProcessActionHandlerParameterName, getReload, getRequestHelpDefinition, getRuntimeDefaultSource, getSource, getSourceById, getSourceContext, getUnboundedConverter, loadFromRequest, setDefaultValue, setRawValue, setReload, setSourceParameter, setValid, setValueFromSource, setValueFromSource, update

Methods inherited from class lumis.doui.control.DataControl

convertValueToControlValue, getConverter, getDataType, getDefaultValue, getParameterValue, getProcessActionIds, getRequestParameterName, getValue, getValue, initProcessActionIds, isTrim, loadSubControlFromRequest, loadSubControlsFromRequest, setProcessActionHandlerParameter, setProcessActionHandlerParameter, setProcessActionHandlerParameters, setSourceParameter, setSourceParameters, setTrim, setValue, valueIsArray

Methods inherited from class lumis.doui.control.Control

appendSubControl, appendSubControls, applyOnEventScripts, convertToStandardValue, createContainer, disconnect, generateControlId, generateControlIdPrefix, getAdditionalParameters, getAdditionalParameters, getAncestor, getChildControls, getClientEventHandlerScript, getId, getLocale, getName, getNamespace, getParentControl, getPrepareForReadScript, getRenderData, getResources, getScriptActionValidation, getType, getValidationScript, getWindowProperties, getWindowProperties, isRequired, isValid, localize, localizeStrings, processCustomTags, registerOnEventScript, removeChild, removeChildren, resolveVariable, setName, setRuntimeAttributes

Methods inherited from class java.lang.Object

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

Methods inherited from interface lumis.doui.control.IControl

createContainer, disconnect, getChildControls, getId, getName, getParentControl, getPrepareForReadScript, getRenderData, getResources, getType, isValid, registerOnEventScript, removeChild, removeChildren, setRuntimeAttributes

Methods inherited from interface lumis.doui.control.IDataControl

getConverter, getProcessActionIds, getValue, getValue, setProcessActionHandlerParameters, setValue

Methods inherited from interface lumis.doui.render.IRenderer

getResources

Field Detail

SHOW_USERS

protected static final java.lang.String SHOW_USERS

See Also:

Constant Field Values

SHOW_GROUPS

protected static final java.lang.String SHOW_GROUPS

See Also:

Constant Field Values

SHOW_ALL

protected static final java.lang.String SHOW_ALL

See Also:

Constant Field Values

Constructor Detail

PrincipalPickerControl

public PrincipalPickerControl()

Method Detail

init

public void init(org.w3c.dom.Node controlDefinitionNode,
                 ControlContainer controlContainer,
                 IControl parentControl)
          throws PortalException

Specified by:

init in interface IControl

Overrides:

init in class DataBoundControl

Throws:

PortalException

buildSubControls

public void buildSubControls()
                      throws PortalException

Specified by:

buildSubControls in interface IControl

Overrides:

buildSubControls in class DataBoundControl

Throws:

PortalException

getValueClass

protected java.lang.Class<? extends PrincipalDataType.Data> getValueClass()
                                                                   throws PortalException

Description copied from class: DataControl

Returns the class the possible values of this control are assignable to.

This default implementation uses IDouiDataType.getValueClass() of the data type of this control.

Overrides:

getValueClass in class DataControl

Returns:

the class the possible values of this control are assignable to.

Throws:

PortalException

setRenderData

public void setRenderData()
                   throws PortalException

Specified by:

setRenderData in interface IControl

Overrides:

setRenderData in class DataBoundControl

Throws:

PortalException

getPopupUrl

protected IServiceInterfaceUrl getPopupUrl()
                                    throws PortalException

Throws:

PortalException

getShowType

protected java.lang.Integer getShowType()

Returns the type of principals be showed. The current types are PrincipalConfig.TYPE_GROUP or PrincipalConfig.TYPE_USER, if no type was defined returns null.

Returns:

the type of principals be showed.

Since:

7.0.0

getSelectPrincipalFunctionName

protected java.lang.String getSelectPrincipalFunctionName()

Returns the script function name for selecting a principal.

Returns:

the script function name for selecting a principal.

Since:

7.0.0

getStringsToLocalize

protected java.util.Map<java.lang.String,java.lang.String> getStringsToLocalize()

Overrides:

getStringsToLocalize in class Control

getControlResource

public IResource getControlResource()
                             throws PortalException

Specified by:

getControlResource in interface IControl

Overrides:

getControlResource in class Control

Throws:

PortalException

fixedIdentifierRequired

protected boolean fixedIdentifierRequired()

Overrides:

fixedIdentifierRequired in class Control

createDataType

protected IDouiDataType createDataType()
                                throws PortalException

Description copied from class: DataBoundControl

Creates the data type to be used for this control.

For a data bound control, if no data type was specified in the control definition, the data type of its associated source field will be used, if any.

Overrides:

createDataType in class DataBoundControl

Returns:

the data type to be used for this control, or null if this control does not knows which data type to use.

Throws:

PortalException