peoplePickerDialog (CAF Tags Documentation)

Description:
A movable modal dialog that enables the user to select one or more principals: users, groups, or roles. Use the People Picker Dialog control to replace the deprecated Principal Picker Dialog control.

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 principal
- com.webmethods.portal.system.IURI - the My webMethods ServerID of the principal
- java.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.

Component Information
Info	Value
Component Type	`com.softwareag.caf.controls.mwsx.PeoplePickerDialog`
Handler Class	`com.softwareag.caf.controls.mwsx.PeoplePickerDialogHandler`
Renderer Type	None
Description	Modal Dialog for selecting people
Palette Location	`MWS Html/Control/MWSX/People/People Picker Dialog`
Client-Side Model	`CAF.Dialog.Modal.Model`

Facets

Name Description

popupPanel Body of the Popup Menu for a person.

Facets
Name	Description
`popupPanel`	Body of the Popup Menu for a person.

Attributes
Name	Required	Type	Description
`advancedSearchAvailable`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	If true, the 'Advanced' tab is visible to the end user If not specified, the default value is "true".
`applyButtonActionExpression`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	Apply Button action method expression
`asyncGoRefresh`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Specifies the control to refresh when using an 'Async Go button'
`buildQueryStringAction`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	The action handler for the 'Go' button
`buildQueryStringActionExpression`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	The action handler for the 'Go' button
`cancelSearchOptionsAction`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	WARNING: This property has been deprecated. Use cancelSearchOptionsActionExpression property instead The action handler for the 'Cancel' button on the 'Options' tab
`cancelSearchOptionsActionExpression`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	The action handler for the 'Cancel' button on the 'Options' tab
`changeActiveSavedSearchAction`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	WARNING: This property has been deprecated. Use changeActiveSavedSearchActionExpression property instead The action handler for changing the active saved search
`changeActiveSavedSearchActionExpression`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	The action handler for changing the active saved search
`clearFormAction`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	The action handler for the 'Clear' button
`clearFormActionExpression`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	The action handler for the 'Clear' button
`clearFormButtonAvailable`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	If true, the 'Clear' button is visible for Search/Advanced/Saved tabs If not specified, the default value is "true".
`defaultCommand`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Id of default command control Valid values are: _none [any_other_value]
`defaultFocus`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Id of control to focus initially Valid values are: _first _none [any_other_value]
`deleteSavedAction`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	WARNING: This property has been deprecated. Use deleteSavedActionExpression property instead The action handler for the saved search 'Delete' button
`deleteSavedActionExpression`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	The action handler for the saved search 'Delete' button
`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
`keywordsFieldAvailable`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	If true, the 'Keywords' controls are visible for Search/Advanced/Saved tabs If not specified, the default value is "true".
`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".
`maxResultsFieldAvailable`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	If true, the 'Max Results' controls are visible on the 'Options' tab If not specified, the default value is "true".
`maxResultsMaxValue`	`false`	`javax.el.ValueExpression` (must evaluate to `long`)	Set the maximum number that user can specify for the 'Max Results' value If not specified, the default value is "2000".
`multipleSelectionsAllowed`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	Allow Multiple Selections If not specified, the default value is "true".
`persistSearchOptionsAction`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	WARNING: This property has been deprecated. Use persistSearchOptionsActionExpression property instead The action handler for the 'Save' button on the 'Options' tab
`persistSearchOptionsActionExpression`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	The action handler for the 'Save' button on the 'Options' tab
`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".
`refineSearchButtonAvailable`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	If true, the 'Refine' button on the 'Search' tab is visible to the end user If not specified, the default value is "true".
`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".
`savedSearchProvider`	`false`	`javax.el.ValueExpression` (must evaluate to `com.webmethods.caf.faces.search.saved.ISavedSearchProvider`)	Value binding that specifies the saved search provider
`saveQueryAction`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	WARNING: This property has been deprecated. Use saveQueryActionExpression property instead The action handler adding a new saved search
`saveQueryActionExpression`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	The action handler adding a new saved search
`saveSearchAvailable`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	If true, the 'Saved' tab is visible to the end user If not specified, the default value is "true".
`searchOptionsManager`	`false`	`javax.el.ValueExpression` (must evaluate to `com.webmethods.caf.faces.search.options.ISearchOptionsManager`)	Value binding that specifies the search options manager
`searchQueryFactory`	`false`	`javax.el.ValueExpression` (must evaluate to `com.webmethods.caf.faces.search.query.ISearchQueryFactory`)	Value binding that specifies a factory for search query objects
`simpleSearchAvailable`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	If true, the 'Search' tab is visible to the end user 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 requests If 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".
`updateSavedQueryAction`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	WARNING: This property has been deprecated. Use updateSavedQueryActionExpression property instead The action handler for the updating an existing saved search
`updateSavedQueryActionExpression`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	The action handler for the updating an existing saved search
`useAsyncGoButton`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	If true, the 'Go' button will use an 'Async Command Button' If not specified, the default value is "false".
`useOrConditionAvailable`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	If true, the 'Match Any/All' dropdown is visible If not specified, the default value is "true".
`userSearchAllowed`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	Allow the user to search for users If not specified, the default value is "true".
`userSearchOptionsAvailable`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	If true, the 'Options' tab is visible to the end user If not specified, the default value is "true".

People Picker Dialog - mws_h:peoplePickerDialog