Tag Documentation

Description:

Note: For more control information, refer to the CAF control documentation in the webMethods CAF Development Help.
Dialog for Picking Users, Groups and/or Roles

Component Information
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

Attributes
Name	Required	Type	Description
`isMoveable`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	Whether this Dialog can be moved by the user
`id`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Control identifier
`rendered`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	True to render control; false to ignore it
`defaultCommand`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Id of default command control
`defaultFocus`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Id of control to focus initially
`disableWhenHidden`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	Disables input controls when panel is hidden, preventing the input controls from submitting
`lazy`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	True if panel loads content asynchronously on demand
`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.
`twoPass`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	Render initial content asynchronously. Ignored if Lazy Load is false.
`suppressInputs`	`false`	`javax.el.ValueExpression` (must evaluate to `java.util.Collection`)	Ids of controls on which to disallow update processing while handling asynchronous requests
`progressDelay`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Integer`)	Milliseconds to wait before showing progress dialog
`progressFlashOnComplete`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	True if panel should flash when asynchronous loading has completed
`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
`refreshOnApply`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Id of control to refresh (defaults to entire form)
`applyButtonAction`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	Apply Button action method binding
`simpleSearchAvailable`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	If true, the 'Search' tab is visible to the end user
`advancedSearchAvailable`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	If true, the 'Advanced' tab is visible to the end user
`saveSearchAvailable`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	If true, the 'Saved' tab is visible to the end user
`userSearchOptionsAvailable`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	If true, the 'Options' tab is visible to the end user
`refineSearchButtonAvailable`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	If true, the 'Refine' button on the 'Search' tab is visible to the end user
`useOrConditionAvailable`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	If true, the 'Match Any/All' dropdown is visible
`maxResultsFieldAvailable`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	If true, the 'Max Results' controls are visible on the 'Options' tab
`keywordsFieldAvailable`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	If true, the 'Keywords' controls are visible for Search/Advanced/Saved tabs
`clearFormButtonAvailable`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	If true, the 'Clear' button is visible for Search/Advanced/Saved tabs
`buildQueryStringAction`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	The action handler for the 'Go' button
`clearFormAction`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	The action handler for the 'Clear' button
`saveQueryAction`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	The action handler adding a new saved search
`changeActiveSavedSearchAction`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	The action handler for changing the active saved search
`deleteSavedAction`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	The action handler for the saved search 'Delete' button
`updateSavedQueryAction`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	The action handler for the updating an existing saved search
`persistSearchOptionsAction`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	The action handler for the 'Save' button on the 'Options' tab
`cancelSearchOptionsAction`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	The action handler for the 'Cancel' button on the 'Options' tab
`maxResultsMaxValue`	`false`	`javax.el.ValueExpression` (must evaluate to `long`)	Set the maximum number that user can specify for the 'Max Results' value
`useAsyncGoButton`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	If true, the 'Go' button will use an 'Async Command Button'
`asyncGoRefresh`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Specifies the control to refresh when using an 'Async Go button'
`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
`savedSearchProvider`	`false`	`javax.el.ValueExpression` (must evaluate to `com.webmethods.caf.faces.search.saved.ISavedSearchProvider`)	Value binding that specifies the saved search provider
`searchOptionsManager`	`false`	`javax.el.ValueExpression` (must evaluate to `com.webmethods.caf.faces.search.options.ISearchOptionsManager`)	Value binding that specifies the search options manager
`userSearchAllowed`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	Allow the user to search for users
`groupSearchAllowed`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	Allow the user to search for groups
`roleSearchAllowed`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	Allow the user to search for roles
`multipleSelectionsAllowed`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	Allow Multiple Selections
`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.

mws_h

Tag principalPickerDialog