A swap box control for choosing users, groups, or roles.
The selected principals are referenced by the control's targetValue property. For a single-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.
| Info | Value |
|---|---|
| Component Type | com.softwareag.caf.controls.mwsx.PeopleSwapBox |
| Handler Class | com.softwareag.caf.controls.mwsx.PeopleSwapBoxHandler |
| Renderer Type | None |
| Description | Specialized SwapBox for choosing users/groups/roles. |
| Palette Location | MWS Html/Control/MWSX/People/People SwapBox |
| Client-Side Model | CAF.Output.Model |
| Name | Description |
|---|---|
popupPanel | Body of the Popup Menu for a person. |
| Name | Required | Type | Description |
|---|---|---|---|
activeSearchQuery | false | javax.el.ValueExpression
(must evaluate to com.webmethods.caf.faces.search.query.ISearchQuery)
| Search query defined by search bar control |
id | false | java.lang.String | Control identifier |
multipleSelectionsAllowed | false | javax.el.ValueExpression
(must evaluate to boolean)
|
Allow Multiple Selections
If not specified, the default value is "true". |
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". |
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. |
Output generated by Vdldoc View Declaration Language Documentation Generator.