Package org.opencms.workplace.commons

Class CmsPrincipalSelectionList

java.lang.Object

org.opencms.workplace.CmsWorkplace

org.opencms.workplace.tools.CmsToolDialog

org.opencms.workplace.CmsDialog

org.opencms.workplace.list.A_CmsListDialog

org.opencms.workplace.commons.CmsPrincipalSelectionList

public class CmsPrincipalSelectionList
extends A_CmsListDialog

Principal selection dialog.

Since:

6.5.6

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LIST_ACTION_ICON	list action id constant.
static final String	LIST_ACTION_SELECT	list action id constant.
static final String	LIST_COLUMN_DESCRIPTION	list column id constant.
static final String	LIST_COLUMN_DISPLAY	list column id constant.
static final String	LIST_COLUMN_ICON	list column id constant.
static final String	LIST_COLUMN_NAME	list column id constant.
static final String	LIST_COLUMN_ORGUNIT	list column id constant.
static final String	LIST_DETAIL_OTHEROU	list item detail id constant.
static final String	LIST_IACTION_GROUPS	list action id constant.
static final String	LIST_IACTION_USERS	list action id constant.
static final String	LIST_ID	list id constant.
static final String	PATH_BUTTONS	Path to the list buttons.

Fields inherited from class org.opencms.workplace.list.A_CmsListDialog

ACTION_LIST_INDEPENDENT_ACTION, ACTION_LIST_MULTI_ACTION, ACTION_LIST_SEARCH, ACTION_LIST_SELECT_PAGE, ACTION_LIST_SINGLE_ACTION, ACTION_LIST_SORT, ICON_ACTIVE, ICON_ADD, ICON_DELETE, ICON_DETAILS_HIDE, ICON_DETAILS_SHOW, ICON_DISABLED, ICON_INACTIVE, ICON_MINUS, ICON_MULTI_ACTIVATE, ICON_MULTI_ADD, ICON_MULTI_DEACTIVATE, ICON_MULTI_DELETE, ICON_MULTI_MINUS, KEY_META_DATA_CACHE, LIST_INDEPENDENT_ACTION, LIST_MULTI_ACTION, LIST_SEARCH, LIST_SELECT_PAGE, LIST_SINGLE_ACTION, LIST_SORT, m_lazy, PARAM_FORMNAME, PARAM_LIST_ACTION, PARAM_PAGE, PARAM_SEARCH_FILTER, PARAM_SEL_ITEMS, PARAM_SORT_COL

Fields inherited from class org.opencms.workplace.CmsDialog

ACTION_CANCEL, ACTION_CLOSEPOPUP, ACTION_CLOSEPOPUP_SAVE, ACTION_CONFIRMED, ACTION_CONTINUE, ACTION_DEFAULT, ACTION_LOCKS_CONFIRMED, ACTION_OK, ACTION_REPORT_BEGIN, ACTION_REPORT_END, ACTION_REPORT_UPDATE, ACTION_SET, ACTION_WAIT, ATTRIBUTE_THROWABLE, BUTTON_ADVANCED, BUTTON_BACK, BUTTON_CANCEL, BUTTON_CLOSE, BUTTON_CONTINUE, BUTTON_DETAILS, BUTTON_DISCARD, BUTTON_EDIT, BUTTON_OK, BUTTON_OK_NO_SUBMIT, BUTTON_SET, DIALOG_BACK, DIALOG_CANCEL, DIALOG_CONFIRMED, DIALOG_CONTINUE, DIALOG_INITIAL, DIALOG_LOCKS_CONFIRMED, DIALOG_OK, DIALOG_SET, DIALOG_WAIT, PARAM_ACTION, PARAM_ACTION_VALUE_FOR_CHANGED_INDEX, PARAM_CLOSELINK, PARAM_DIALOGTYPE, PARAM_ERRORSTACK, PARAM_FILE, PARAM_FRAMENAME, PARAM_ISPOPUP, PARAM_LOCK, PARAM_MESSAGE, PARAM_ORIGINALPARAMS, PARAM_PREACTIONDONE, PARAM_REDIRECT, PARAM_RESOURCE, PARAM_TARGET, PARAM_THREAD, PARAM_THREAD_HASNEXT, PARAM_TITLE, REPORT_BEGIN, REPORT_END, REPORT_UPDATE

Fields inherited from class org.opencms.workplace.tools.CmsToolDialog

PARAM_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW

Fields inherited from class org.opencms.workplace.CmsWorkplace

DEBUG, DEFAULT_DATE_STRING, DEFAULT_LANGUAGE, DEFAULT_LOCALE, DIALOG_PATH_COMMON, FILE_DIALOG_CLOSE, FILE_DIALOG_SCREEN_CONFIRM, FILE_DIALOG_SCREEN_ERROR, FILE_DIALOG_SCREEN_ERRORPAGE, FILE_DIALOG_SCREEN_WAIT, FILE_EXPLORER_FILELIST, FILE_REPORT_OUTPUT, HTML_END, HTML_START, INPUT_DEFAULT, INPUT_NONE, JSP_WORKPLACE_URI, PARAM_DIRECTPUBLISH, PARAM_MODELFILE, PARAM_NEWRESOURCETYPE, PARAM_PUBLISHSIBLINGS, PARAM_RELATEDRESOURCES, PARAM_RESOURCELIST, PARAM_SUBRESOURCES, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PARAM_WP_START, PARAM_WP_VIEW, PATH_DIALOGS, PATH_WORKPLACE, REQUEST_ATTRIBUTE_MULTIPART, REQUEST_ATTRIBUTE_RELOADTREE, RES_PATH_FILETYPES, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, VFS_DIR_DEFAULTBODIES, VFS_DIR_TEMPLATES, VFS_PATH_COMMONS, VFS_PATH_EDITORS, VFS_PATH_GALLERIES, VFS_PATH_LOCALES, VFS_PATH_MODELDIALOG, VFS_PATH_MODULES, VFS_PATH_NEWRESOURCEDIALOG, VFS_PATH_RESOURCES, VFS_PATH_SITES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_ADMIN, VIEW_DIRECT_EDIT, VIEW_EXPLORER, VIEW_GALLERY, VIEW_LIST, VIEW_WORKPLACE

Constructor Summary

Constructors

Constructor	Description
CmsPrincipalSelectionList(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)	Public constructor with JSP variables.
CmsPrincipalSelectionList(org.opencms.jsp.CmsJspActionElement jsp)	Public constructor.

Method Summary

Modifier and Type	Method	Description
String	dialogTitle()
void	executeListIndepActions()	This method should handle the default list independent actions, by comparing A_CmsListDialog.getParamListAction() with the id of the action to execute.
void	executeListMultiActions()	This method should handle every defined list multi action, by comparing A_CmsListDialog.getParamListAction() with the id of the action to execute.
void	executeListSingleActions()	This method should handle every defined list single action, by comparing A_CmsListDialog.getParamListAction() with the id of the action to execute.
protected void	fillDetails(String detailId)	Lazy initialization for detail data.
String	getIconPath(CmsListItem item)	Returns the right icon path for the given list item.
protected List<CmsListItem>	getListItems()	Should generate a list with the list items to be displayed.
String	getParamFlags()	Returns the flags parameter value.
String	getParamRealonly()	Gets the 'realonly parameter'.
String	getParamUseparent()	Returns the use parent frame flag.
protected List<org.opencms.security.CmsPrincipal>	getPrincipals(boolean includeOtherOus)	Returns the list of principals for selection.
boolean	hasPrincipalsInOtherOus()	Returns if the list of principals has principals of other organizational units.
protected void	initializeDetail(String detailId)	Lazy details initialization.
boolean	isShowingUsers()	Checks if we are currently displaying users or groups.
protected void	setColumns(CmsListMetadata metadata)	Should create the columns and add them to the given list metadata object.
protected void	setIndependentActions(CmsListMetadata metadata)	Should add the independent actions to the given list metadata object.
protected void	setMultiActions(CmsListMetadata metadata)	Should add the multi actions to the given list metadata object.
void	setParamFlags(String flags)	Sets the flags parameter value.
void	setParamRealonly(String realonly)	Sets the 'realonly' parameter.
void	setParamUseparent(String useParent)	Sets the use parent frame flag.
protected void	validateParamaters()	Should be overridden for parameter validation.

Methods inherited from class org.opencms.workplace.list.A_CmsListDialog

actionDialog, customHtmlEnd, customHtmlStart, defaultActionHtml, defaultActionHtmlContent, defaultActionHtmlEnd, defaultActionHtmlStart, displayDialog, displayDialog, executeDefaultActions, executeSearch, executeSelectPage, executeSort, fillList, getList, getListId, getListObject, getListState, getMetadata, getMetadata, getMetadataCache, getParamFormName, getParamListAction, getParamPage, getParamSearchFilter, getParamSelItems, getParamSortCol, getSelectedItem, getSelectedItems, initWorkplaceRequestValues, isActive, listRecovery, listSave, refreshList, removeList, setList, setListObject, setParamFormName, setParamListAction, setParamPage, setParamSearchFilter, setParamSelItems, setParamSortCol, setSearchAction, throwListUnsupportedActionException, writeDialog

Methods inherited from class org.opencms.workplace.CmsDialog

actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockHeaderBox, checkResourcePermissions, checkResourcePermissions, computeCurrentFolder, dialog, dialogBlock, dialogBlockEnd, dialogBlockStart, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, dialogButtonsHtml, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, dialogButtonsOkCancelAdvanced, dialogButtonsSetOkCancel, dialogContent, dialogContentEnd, dialogContentStart, dialogEnd, dialogHead, dialogHorizontalSpacer, dialogLockButtons, dialogRow, dialogRowEnd, dialogRowStart, dialogScriptSubmit, dialogSeparator, dialogSpacer, dialogStart, dialogStart, dialogSubheadline, dialogToggleStart, dialogWhiteBox, dialogWhiteBoxEnd, dialogWhiteBoxStart, getAction, getAdministrationBackLink, getCancelAction, getDialogRealUri, getDialogUri, getOnlineHelpUriCustom, getParamAction, getParamCloseLink, getParamDialogtype, getParamFramename, getParamIsPopup, getParamMessage, getParamOriginalParams, getParamPreActionDone, getParamRedirect, getParamResource, getParamTitle, getState, hasCorrectLockstate, hasSiblings, htmlStart, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, isPreEditor, openLaunchpad, openWorkplaceLink, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamResource, setParamTitle

Methods inherited from class org.opencms.workplace.tools.CmsToolDialog

computeUpLevelLink, getAdminTool, getCurrentToolPath, getParamBase, getParamForce, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, setParamForce, setParamPath, setParamRoot, setParamStyle, useNewStyle

Methods inherited from class org.opencms.workplace.CmsWorkplace

addMessages, addMessages, allParamsAsHidden, allParamsAsRequest, allParamValues, bodyEnd, bodyStart, bodyStart, buildSelect, buildSelect, button, button, buttonBar, buttonBar, buttonBarHorizontalLine, buttonBarLabel, buttonBarLabel, buttonBarLine, buttonBarLineSpacer, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, canEditPermissionsForRoles, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, generateCssStyle, generatePageEndExtended, generatePageEndSimple, generatePageStartExtended, generatePageStartSimple, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStartSiteRoot, getStartSiteRoot, getStaticResourceUri, getStaticResourceUri, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, getWorkplaceExplorerLink, getWorkplaceExplorerLink, getWorkplaceSettings, htmlEnd, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, substituteSiteTitleStatic, switchToCurrentProject, switchToTempProject, updateUserPreferences

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LIST_ACTION_ICON

public static final String LIST_ACTION_ICON

list action id constant.

See Also:

• Constant Field Values

LIST_ACTION_SELECT

public static final String LIST_ACTION_SELECT

list action id constant.

See Also:

• Constant Field Values

LIST_COLUMN_DESCRIPTION

public static final String LIST_COLUMN_DESCRIPTION

list column id constant.

See Also:

• Constant Field Values

LIST_COLUMN_DISPLAY

public static final String LIST_COLUMN_DISPLAY

list column id constant.

See Also:

• Constant Field Values

LIST_COLUMN_ICON

public static final String LIST_COLUMN_ICON

list column id constant.

See Also:

• Constant Field Values

LIST_COLUMN_NAME

public static final String LIST_COLUMN_NAME

list column id constant.

See Also:

• Constant Field Values

LIST_COLUMN_ORGUNIT

public static final String LIST_COLUMN_ORGUNIT

list column id constant.

See Also:

• Constant Field Values

LIST_DETAIL_OTHEROU

public static final String LIST_DETAIL_OTHEROU

list item detail id constant.

See Also:

• Constant Field Values

LIST_IACTION_GROUPS

public static final String LIST_IACTION_GROUPS

list action id constant.

See Also:

• Constant Field Values

LIST_IACTION_USERS

public static final String LIST_IACTION_USERS

list action id constant.

See Also:

• Constant Field Values

LIST_ID

public static final String LIST_ID

list id constant.

See Also:

• Constant Field Values

PATH_BUTTONS

public static final String PATH_BUTTONS

Path to the list buttons.

See Also:

• Constant Field Values

Constructor Details

CmsPrincipalSelectionList

public CmsPrincipalSelectionList(org.opencms.jsp.CmsJspActionElement jsp)

Public constructor.

Parameters:

jsp - an initialized JSP action element

CmsPrincipalSelectionList

public CmsPrincipalSelectionList(javax.servlet.jsp.PageContext context,
 javax.servlet.http.HttpServletRequest req,
 javax.servlet.http.HttpServletResponse res)

Public constructor with JSP variables.

Parameters:

context - the JSP page context

req - the JSP request

res - the JSP response

Method Details

dialogTitle

public String dialogTitle()

Overrides:

dialogTitle in class org.opencms.workplace.tools.CmsToolDialog

See Also:

• CmsToolDialog.dialogTitle()

executeListIndepActions

public void executeListIndepActions()

Description copied from class: A_CmsListDialog

This method should handle the default list independent actions, by comparing A_CmsListDialog.getParamListAction() with the id of the action to execute.

if you want to handle additional independent actions, override this method, handling your actions and FINALLY calling super.executeListIndepActions();.

Overrides:

executeListIndepActions in class A_CmsListDialog

See Also:

• A_CmsListDialog.executeListIndepActions()

executeListMultiActions

public void executeListMultiActions()
                             throws org.opencms.main.CmsRuntimeException

Description copied from class: A_CmsListDialog

This method should handle every defined list multi action, by comparing A_CmsListDialog.getParamListAction() with the id of the action to execute.

Specified by:

executeListMultiActions in class A_CmsListDialog

Throws:

org.opencms.main.CmsRuntimeException - to signal that an action is not supported

See Also:

• A_CmsListDialog.executeListMultiActions()

executeListSingleActions

public void executeListSingleActions()
                              throws org.opencms.main.CmsRuntimeException

Description copied from class: A_CmsListDialog

This method should handle every defined list single action, by comparing A_CmsListDialog.getParamListAction() with the id of the action to execute.

Specified by:

executeListSingleActions in class A_CmsListDialog

Throws:

org.opencms.main.CmsRuntimeException - to signal that an action is not supported

See Also:

• A_CmsListDialog.executeListSingleActions()

getIconPath

public String getIconPath(CmsListItem item)

Returns the right icon path for the given list item.

Parameters:

item - the list item to get the icon path for

Returns:

the icon path for the given role

getParamFlags

public String getParamFlags()

Returns the flags parameter value.

Returns:

the flags parameter value

getParamRealonly

public String getParamRealonly()

Gets the 'realonly parameter'.

This controls whether pseudo-principals like 'ALL OTHERS' should be shown or not.

Returns:

the parameter value

getParamUseparent

public String getParamUseparent()

Returns the use parent frame flag.

Returns:

the use parent frame flag

hasPrincipalsInOtherOus

public boolean hasPrincipalsInOtherOus()

Returns if the list of principals has principals of other organizational units.

Returns:

if the list of principals has principals of other organizational units

isShowingUsers

public boolean isShowingUsers()

Checks if we are currently displaying users or groups.

Returns:

true if we are currently displaying users

setParamFlags

public void setParamFlags(String flags)

Sets the flags parameter value.

Parameters:

flags - the flags parameter value to set

setParamRealonly

public void setParamRealonly(String realonly)

Sets the 'realonly' parameter.

This controls whether 'pseudo-principals' like 'ALL OTHERS' should be shown or not.

Parameters:

realonly - the parameter value

setParamUseparent

public void setParamUseparent(String useParent)

Sets the use parent frame flag.

Parameters:

useParent - the use parent frame flag

fillDetails

protected void fillDetails(String detailId)

Description copied from class: A_CmsListDialog

Lazy initialization for detail data.

Should fill the given detail column for every list item in CmsHtmlList.getContent() Should not throw any kind of exception.

Specified by:

fillDetails in class A_CmsListDialog

Parameters:

detailId - the id of the detail to initialize

See Also:

• A_CmsListDialog.fillDetails(java.lang.String)

getListItems

protected List<CmsListItem> getListItems()
                                  throws org.opencms.main.CmsException

Description copied from class: A_CmsListDialog

Should generate a list with the list items to be displayed.

Specified by:

getListItems in class A_CmsListDialog

Returns:

a list of CmsListItems

Throws:

org.opencms.main.CmsException - if something goes wrong

See Also:

• A_CmsListDialog.getListItems()

getPrincipals

protected List<org.opencms.security.CmsPrincipal> getPrincipals(boolean includeOtherOus)
                                                         throws org.opencms.main.CmsException

Returns the list of principals for selection.

Parameters:

includeOtherOus - if to include other ou's in the selection

Returns:

a list of principals

Throws:

org.opencms.main.CmsException - if womething goes wrong

initializeDetail

protected void initializeDetail(String detailId)

Description copied from class: A_CmsListDialog

Lazy details initialization.

Overrides:

initializeDetail in class A_CmsListDialog

Parameters:

detailId - the id of the detail column

See Also:

• A_CmsListDialog.initializeDetail(java.lang.String)

setColumns

protected void setColumns(CmsListMetadata metadata)

Description copied from class: A_CmsListDialog

Should create the columns and add them to the given list metadata object.

This method will be just executed once, the first time the constructor is called.

Specified by:

setColumns in class A_CmsListDialog

Parameters:

metadata - the list metadata

See Also:

• A_CmsListDialog.setColumns(org.opencms.workplace.list.CmsListMetadata)

setIndependentActions

protected void setIndependentActions(CmsListMetadata metadata)

Description copied from class: A_CmsListDialog

Should add the independent actions to the given list metadata object.

This method will be just executed once, the first time the constructor is called.

Specified by:

setIndependentActions in class A_CmsListDialog

Parameters:

metadata - the list metadata

See Also:

• A_CmsListDialog.setIndependentActions(org.opencms.workplace.list.CmsListMetadata)

setMultiActions

protected void setMultiActions(CmsListMetadata metadata)

Description copied from class: A_CmsListDialog

Should add the multi actions to the given list metadata object.

This method will be just executed once, the first time the constructor is called.

Specified by:

setMultiActions in class A_CmsListDialog

Parameters:

metadata - the list metadata

See Also:

• A_CmsListDialog.setMultiActions(org.opencms.workplace.list.CmsListMetadata)

validateParamaters

protected void validateParamaters()
                           throws Exception

Description copied from class: A_CmsListDialog

Should be overridden for parameter validation.

Overrides:

validateParamaters in class A_CmsListDialog

Throws:

Exception - if the parameters are not valid

See Also:

• A_CmsListDialog.validateParamaters()