public interface IPeoplePickerWrapper
Modifier and Type | Interface and Description |
---|---|
static class |
IPeoplePickerWrapper.WrapperPeopleSelectionMode |
static class |
IPeoplePickerWrapper.WrapperUMEPrincipalType |
Modifier and Type | Method and Description |
---|---|
String |
getButtonText()
gets the button text
|
int |
getCols()
gets the visible number of columns for this TextEdit in multi selection mode
|
String |
getDocumentRid()
Returns the document rid
|
String |
getErrorMessage()
Returns the error message provided by the PeoplePicker.
|
String |
getHeight()
gets the height for the TextEdit in multi selection mode
|
com.sapportals.htmlb.LabeledComponent |
getLabeledComponent()
Returns the component which has to be labeled to enable
accessibility (input field or text edit)
Caution: setPeopleSelectionMode() has to be called before this
method in order to determine if an input field or an text edit
has to be returned as labeled component
|
IPeoplePickerWrapper.WrapperPeopleSelectionMode |
getPeopleWrapperSelectionMode()
Returns the people selection mode (single or multiple people).
|
int |
getResolvedUserIdsCount() |
int |
getResolvedUserIdsCount(int maxAllowedCount) |
int |
getResolvedUserIdsCount(int maxAllowedCount,
HashSet<String> peopleIdsSet) |
int |
getRows()
gets the visible number of rows for the TextEdit in multi selection mode
|
ArrayList<String> |
getSelectedExternalEmailAddresses()
Returns selected external email addresses (String).
|
ArrayList<String> |
getSelectedPeopleIds()
Returns selected principal IDs (String) for all UME principal types.
|
int |
getSize()
gets the size of the InputField.
|
String |
getTooltip()
gets the Tooltip for this TextView.
|
String |
getWidth()
get the width of the people picker input field
|
ArrayList<String> |
getWrapperSelectedPeopleIds(IPeoplePickerWrapper.WrapperUMEPrincipalType peopleType)
Returns selected principal IDs (String) according to the specified UME principal type.
|
boolean |
isAllowExternalEmailAddresses()
Returns if the PeoplePicker can select external email addresses.
|
boolean |
isAutomaticValidation()
indicates if the PeoplePicker calls a popup automatically
in case of being rendered with a not valid people selection
state (usecase: enduser enters not valid users and triggers
an application event directly)
|
boolean |
isDuplicatePeopleSelection()
Returns if duplicate people selection is allowed
|
boolean |
isEnabled()
Sets whether this component is disabled.
|
boolean |
isLabeled()
indicates if the PeoplePicker is labeled
|
boolean |
isMessageVisible()
Indicates if the message is displayed in the PeoplePicker component.
|
boolean |
isOnlineStateVisible()
Returns if the user awareness state is displayed in the
PeopleFinder popup.
|
boolean |
isRequired()
indicates if the PeoplePicker is required so that at least one people
has to be entered
|
boolean |
isValid()
Returns if all people are identified
|
boolean |
isWrapperSearchFor(IPeoplePickerWrapper.WrapperUMEPrincipalType peopleType)
Returns if the PeoplePicker can select specified principal type.
|
void |
setAllowExternalEmailAddresses(boolean externalAllowed)
Defines if the PeoplePicker can select external email addresses.
|
void |
setAutomaticValidation(boolean automaticValidation)
Defines if the PeoplePicker calls a popup automatically
in case of being rendered with a not valid people selection
state (for example: enduser enters not valid users and triggers
an application event directly)
|
void |
setButtonText(String text)
sets the button text
|
void |
setCols(int cols)
sets the visible number of columns for this TextEdit in multi selection mode
|
void |
setDocumentRidPath(String docRid)
Sets the documents rid.
|
void |
setDuplicatePeopleSelection(boolean duplicatePeopleSelection)
Sets if duplicate people selection is allowed.
|
void |
setEnabled(boolean enabled)
sets this component enabled
|
void |
setErrorMessage(String message)
Sets error message provided by the application.
|
void |
setEventAfterValidation(String eventName,
String id)
sets the name of an event and the id of the component
which triggers the event.
|
void |
setExternalEmailAddresses(ArrayList<String> externalAddresses)
Sets the external email addresses (String) to be displayed initially.
|
void |
setExternalRequiredCheck(boolean isExternalRequiredCheck)
sets that PeoplePicker will be check for empty values from the component that use it
|
void |
setHeight(String height)
sets the height for the TextEdit in multi selection mode
|
void |
setInputFieldsValid(boolean valid)
Defines if the input fields should be marked as invalid.
|
void |
setLabeled(boolean isLabeled)
set if the PeoplePicker is labeled
|
void |
setLabelText(String text)
Sets the label text which has to be provided by the application.
|
void |
setMessageVisible(boolean messageVisible)
Sets if the message is displayed in the PeoplePicker component.
|
void |
setOnlineStateVisible(boolean visible)
Sets if the user awareness state is displayed in the
PeopleFinder popup.
|
void |
setPeopleIds(ArrayList<String> peopleIds)
Sets the principal IDs (com.sap.security.api.IUser,
com.sap.security.api.IGroup,com.sap.security.api.IRole)
for people to be displayed initially.
|
void |
setPeopleWrapperSelectionMode(IPeoplePickerWrapper.WrapperPeopleSelectionMode selectionMode)
Sets the people selection mode (single or multiple people).
|
void |
setRequired(boolean isRequired)
sets if the PeoplePicker is required so that at least one people
has to be entered
|
void |
setRows(int rows)
sets the visible number of rows for this TextEdit in multi selection mode
|
void |
setSearchedTypeSelectable(boolean isSelectable) |
void |
setSize(int size)
sets the size of the InputField.
|
void |
setTooltip(String tooltip)
sets the Tooltip for this TextView.
|
void |
setWidth(String width)
set the width of the people picker input field
|
void |
setWrapperDefaultSearchedType(IPeoplePickerWrapper.WrapperUMEPrincipalType peopleType) |
void |
setWrapperSearchFor(IPeoplePickerWrapper.WrapperUMEPrincipalType peopleType,
boolean searchFor)
Defines which principal types can be entered in the PeoplePicker.
|
boolean isValid()
void setInputFieldsValid(boolean valid)
valid
- sets the input fields invalidIPeoplePickerWrapper.WrapperPeopleSelectionMode getPeopleWrapperSelectionMode()
void setPeopleWrapperSelectionMode(IPeoplePickerWrapper.WrapperPeopleSelectionMode selectionMode)
selectionMode
- people selection modevoid setPeopleIds(ArrayList<String> peopleIds)
peopleIds
- ArrayList with people ids (String)ArrayList<String> getWrapperSelectedPeopleIds(IPeoplePickerWrapper.WrapperUMEPrincipalType peopleType)
peopleType
- people typeArrayList<String> getSelectedPeopleIds()
int getResolvedUserIdsCount()
int getResolvedUserIdsCount(int maxAllowedCount)
maxAllowedCount
- - Maximal allowed count for user IDsint getResolvedUserIdsCount(int maxAllowedCount, HashSet<String> peopleIdsSet)
maxAllowedCount
- - Maximal allowed count for user IDspeopleIdsSet
- - HashSet that will be fill up with resolved User Ids, if the count <= maxAllowedCount.
If the count > maxAllowedCount, peopleIdsSet will be empty.void setExternalEmailAddresses(ArrayList<String> externalAddresses)
externalAddresses
- list with external email addresses (String)ArrayList<String> getSelectedExternalEmailAddresses()
void setWrapperSearchFor(IPeoplePickerWrapper.WrapperUMEPrincipalType peopleType, boolean searchFor)
peopleType
- principal typesearchFor
- defines if the PeoplePicker can select the specified principal typeboolean isWrapperSearchFor(IPeoplePickerWrapper.WrapperUMEPrincipalType peopleType)
peopleType
- principal typevoid setAllowExternalEmailAddresses(boolean externalAllowed)
externalAllowed
- defines if the PeoplePicker can select external email addressesboolean isAllowExternalEmailAddresses()
boolean isOnlineStateVisible()
void setOnlineStateVisible(boolean visible)
visible
- sets if people awareness state is displayedint getSize()
void setSize(int size)
size
- the size of the InputField in characterssetWidth(String)
String getTooltip()
void setTooltip(String tooltip)
tooltip
- the tooltip textvoid setEventAfterValidation(String eventName, String id)
eventName
- name of the eventid
- id of the component which triggers the eventString getWidth()
void setWidth(String width)
width
- the width of the people picker input fieldvoid setLabeled(boolean isLabeled)
isLabeled
- indicator if the people picker is labeledboolean isRequired()
void setRequired(boolean isRequired)
isRequired
- indicator if the people picker is requiredvoid setExternalRequiredCheck(boolean isExternalRequiredCheck)
isExternalRequiredCheck
- indicator if the people picker will be checked externally for empty valuesboolean isLabeled()
boolean isEnabled()
void setEnabled(boolean enabled)
enabled
- true if the InputField
is enabledString getHeight()
void setHeight(String height)
height
- height of TextEdit.int getRows()
void setRows(int rows)
rows
- the number of rows.int getCols()
void setCols(int cols)
cols
- the number of columns.String getButtonText()
void setButtonText(String text)
text
- button textvoid setAutomaticValidation(boolean automaticValidation)
automaticValidation
- boolean flagboolean isAutomaticValidation()
String getErrorMessage()
void setErrorMessage(String message)
message
- error message defined by the applicationString getDocumentRid()
void setDocumentRidPath(String docRid)
docRid
- rid path document rid path set by the CM permission dialogvoid setLabelText(String text)
text
- label text defined by the applicationboolean isMessageVisible()
void setMessageVisible(boolean messageVisible)
true
messageVisible
- defines if the error message is displayedcom.sapportals.htmlb.LabeledComponent getLabeledComponent()
boolean isDuplicatePeopleSelection()
void setDuplicatePeopleSelection(boolean duplicatePeopleSelection)
duplicatePeopleSelection
- Sets if duplicate people selection is allowedvoid setSearchedTypeSelectable(boolean isSelectable)
void setWrapperDefaultSearchedType(IPeoplePickerWrapper.WrapperUMEPrincipalType peopleType)
Access Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com]
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice