WARNING: This tag has been deprecated. Replace with a People Picker Dialog control
A movable modal dialog that enables the user to select one or more principals: users, groups, or roles.
Note: This control is not portable to third-party portals. You can use it only in portlets published to instances of My webMethods Server.
The selected principals are referenced by the control's targetValue
property. For a single-item select picker, the targetValue
property binds to the following data types:
com.webmethods.caf.faces.data.dir.IPrincipalProvider
- a model object that represents the principalcom.webmethods.portal.system.IURI
- the My webMethods ServerID of the principaljava.lang.String
- a string representation of the My webMethods Server ID of the principal
For a multi-select picker, the targetValue
property binds to a list or array of the above types.
You can use the com.webmethods.caf.faces.data.dir.PrincipalModelFactory
and com.webmethods.caf.faces.data.dir.PrincipalModelList
classes to help create individual principal model objects or lists of principal model objects.
Like other visibility controls, this control toggles between visible and hidden through client-side JavaScript code. The toggle controls encapsulate this code within controls that you can visually create and configure using the Composite Application Framework. For more information, see information about concealable controls and toggle controls in the in the webMethods CAF Development Help.
Info | Value |
---|---|
Component Type | com.webmethods.caf.faces.panel.PrincipalPickerModalDialog |
Handler Class | com.webmethods.caf.faces.component.dir.PrincipalPickerModalDialogHandler |
Renderer Type | com.webmethods.caf.faces.panel.ModalDialog |
Description | Dialog for Picking Users, Groups and/or Roles |
Palette Location | MWS Html/Control/Dialog/Principal Picker Dialog |
Client-Side Model | CAF.Dialog.Modal.Model |
Name | Required | Type | Description |
---|---|---|---|
applyButtonActionExpression | false | javax.el.MethodExpression
(signature must match java.lang.String action() )
| Apply Button action method expression |
defaultCommand | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
|
Id of default command control
Valid values are:
|
defaultFocus | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
|
Id of control to focus initially
Valid values are:
|
disableWhenHidden | false | javax.el.ValueExpression
(must evaluate to boolean )
|
Disables input controls when panel is hidden, preventing the input controls from submitting
If not specified, the default value is "false". |
groupSearchAllowed | false | javax.el.ValueExpression
(must evaluate to boolean )
|
Allow the user to search for groups
If not specified, the default value is "true". |
id | false | java.lang.String | Control identifier |
isMoveable | false | javax.el.ValueExpression
(must evaluate to boolean )
| Whether this Dialog can be moved by the user |
lazy | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True if panel loads content asynchronously on demand
If not specified, the default value is "false". |
multipleSelectionsAllowed | false | javax.el.ValueExpression
(must evaluate to boolean )
|
Allow Multiple Selections
If not specified, the default value is "true". |
progressDelay | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer )
|
Milliseconds to wait before showing progress dialog
If not specified, the default value is "0". |
progressFlashOnComplete | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True if panel should flash when asynchronous loading has completed
If not specified, the default value is "true". |
progressMsg | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Progress dialog message; defaults to a localized message, in English "Loading..." |
progressUseHideShowEffect | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True if progress dialog should use panel's hide and show effects; false if progress dialog shouldn't use default effects
If not specified, the default value is "false". |
refreshOnApply | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Id of control to refresh (defaults to entire form) |
refreshOnShow | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True to refresh content every time panel is toggled visible. Ignored if Lazy Load is false.
If not specified, the default value is "false". |
rendered | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True to render control; false to ignore it
If not specified, the default value is "true". |
roleSearchAllowed | false | javax.el.ValueExpression
(must evaluate to boolean )
|
Allow the user to search for roles
If not specified, the default value is "true". |
suppressInputs | false | javax.el.ValueExpression
(must evaluate to java.util.Collection )
|
WARNING: This property has been deprecated. Ids of controls on which to disallow update processing while handling asynchronous requestsIf not specified, the default value is "false". |
targetValue | true | javax.el.ValueExpression
(must evaluate to javax.faces.el.ValueBinding )
| ValueBinding expression for where to copy the selected principal ids when the modal dialog is applied. |
twoPass | false | javax.el.ValueExpression
(must evaluate to boolean )
|
Render initial content asynchronously. Ignored if Lazy Load is false.
If not specified, the default value is "false". |
userSearchAllowed | false | javax.el.ValueExpression
(must evaluate to boolean )
|
Allow the user to search for users
If not specified, the default value is "true". |
Output generated by Vdldoc View Declaration Language Documentation Generator.