org.opencms.workplace.tools.accounts

类 CmsRolesList

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.tools.accounts.A_CmsRolesList

org.opencms.workplace.tools.accounts.CmsRolesList

public class CmsRolesList
extends A_CmsRolesList

Roles overview view.

从以下版本开始:

6.5.6

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	LIST_DEFACTION_OVERVIEW list action id constant.
static java.lang.String	LIST_DETAIL_USERS list item detail id constant.
static java.lang.String	LIST_ID list id constant.
static java.lang.String	PARAM_ROLE Request parameter name for the role name.

从类继承的字段 org.opencms.workplace.tools.accounts.A_CmsRolesList

LIST_ACTION_ICON, LIST_COLUMN_DEPENDENCY, LIST_COLUMN_GROUP_NAME, LIST_COLUMN_HIDDEN_NAME, LIST_COLUMN_ICON, LIST_COLUMN_NAME, LIST_DETAIL_DESCRIPTION, LIST_DETAIL_PATH, PATH_BUTTONS

从类继承的字段 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, 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

从类继承的字段 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_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

从类继承的字段 org.opencms.workplace.tools.CmsToolDialog

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

从类继承的字段 org.opencms.workplace.CmsWorkplace

DEBUG, 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, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, 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_MODULES, VFS_PATH_RESOURCES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_DIRECT_EDIT, VIEW_WORKPLACE

构造器概要

构造器

限定符	构造器和说明
	CmsRolesList(CmsJspActionElement jsp) Public constructor.
	CmsRolesList(CmsJspActionElement jsp, java.lang.String listId) Public constructor.
protected	CmsRolesList(CmsJspActionElement jsp, java.lang.String listId, CmsMessageContainer listName) Public constructor.
	CmsRolesList(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Public constructor with JSP variables.

方法概要

方法

限定符和类型	方法和说明
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(java.lang.String detailId) Lazy initialization for detail data.
java.lang.String	getEditIcon() Returns the path of the edit icon.
java.lang.String	getIconPath(CmsListItem item) Returns the right icon path for the given list item.
protected java.util.List<CmsRole>	getRoles() Returns all roles to display.
protected boolean	includeOuDetails() Returns if the organizational unit details button should be displayed.
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.

从类继承的方法 org.opencms.workplace.tools.accounts.A_CmsRolesList

getListItems, getParamOufqn, setParamOufqn, validateParamaters

从类继承的方法 org.opencms.workplace.list.A_CmsListDialog

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

从类继承的方法 org.opencms.workplace.CmsDialog

actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockDialog, buildLockDialog, 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, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamResource, setParamTitle

从类继承的方法 org.opencms.workplace.tools.CmsToolDialog

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

从类继承的方法 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, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStartSiteRoot, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, htmlEnd, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, switchToCurrentProject, switchToTempProject

从类继承的方法 java.lang.Object

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

字段详细资料

LIST_DEFACTION_OVERVIEW

public static final java.lang.String LIST_DEFACTION_OVERVIEW

list action id constant.

另请参阅:

常量字段值

LIST_DETAIL_USERS

public static final java.lang.String LIST_DETAIL_USERS

list item detail id constant.

另请参阅:

常量字段值

LIST_ID

public static final java.lang.String LIST_ID

list id constant.

另请参阅:

常量字段值

PARAM_ROLE

public static final java.lang.String PARAM_ROLE

Request parameter name for the role name.

另请参阅:

常量字段值

构造器详细资料

CmsRolesList

public CmsRolesList(CmsJspActionElement jsp)

Public constructor.

参数:

jsp - an initialized JSP action element

CmsRolesList

public CmsRolesList(CmsJspActionElement jsp,
            java.lang.String listId)

Public constructor.

参数:

jsp - an initialized JSP action element

listId - the id of the list

CmsRolesList

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

Public constructor with JSP variables.

参数:

context - the JSP page context

req - the JSP request

res - the JSP response

CmsRolesList

protected CmsRolesList(CmsJspActionElement jsp,
            java.lang.String listId,
            CmsMessageContainer listName)

Public constructor.

参数:

jsp - an initialized JSP action element

listId - the id of the list

listName - the name of the list

方法详细资料

executeListMultiActions

public void executeListMultiActions()
                             throws CmsRuntimeException

从类复制的说明: A_CmsListDialog

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

指定者:

executeListMultiActions 在类中 A_CmsListDialog

抛出:

CmsRuntimeException - to signal that an action is not supported

另请参阅:

A_CmsListDialog.executeListMultiActions()

executeListSingleActions

public void executeListSingleActions()
                              throws java.io.IOException,
                                     javax.servlet.ServletException,
                                     CmsRuntimeException

从类复制的说明: A_CmsListDialog

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

指定者:

executeListSingleActions 在类中 A_CmsListDialog

抛出:

java.io.IOException - in case of errors when including a required sub-element

javax.servlet.ServletException - in case of errors when including a required sub-element

CmsRuntimeException - to signal that an action is not supported

另请参阅:

A_CmsListDialog.executeListSingleActions()

getEditIcon

public java.lang.String getEditIcon()

Returns the path of the edit icon.

返回:

the path of the edit icon

getIconPath

public java.lang.String getIconPath(CmsListItem item)

从类复制的说明: A_CmsRolesList

Returns the right icon path for the given list item.

指定者:

getIconPath 在类中 A_CmsRolesList

参数:

item - the list item to get the icon path for

返回:

the icon path for the given role

另请参阅:

A_CmsRolesList.getIconPath(org.opencms.workplace.list.CmsListItem)

fillDetails

protected void fillDetails(java.lang.String detailId)

从类复制的说明: 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.

覆盖:

fillDetails 在类中 A_CmsRolesList

参数:

detailId - the id of the detail to initialize

另请参阅:

A_CmsListDialog.fillDetails(java.lang.String)

getRoles

protected java.util.List<CmsRole> getRoles()
                                    throws CmsException

从类复制的说明: A_CmsRolesList

Returns all roles to display.

指定者:

getRoles 在类中 A_CmsRolesList

返回:

a list of CmsRole objects

抛出:

CmsException - if something goes wrong

另请参阅:

A_CmsRolesList.getRoles()

setColumns

protected void setColumns(CmsListMetadata metadata)

从类复制的说明: 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.

覆盖:

setColumns 在类中 A_CmsRolesList

参数:

metadata - the list metadata

另请参阅:

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

includeOuDetails

protected boolean includeOuDetails()

从类复制的说明: A_CmsRolesList

Returns if the organizational unit details button should be displayed.

覆盖:

includeOuDetails 在类中 A_CmsRolesList

返回:

if the organizational unit details button should be displayed

另请参阅:

A_CmsRolesList.includeOuDetails()

setIndependentActions

protected void setIndependentActions(CmsListMetadata metadata)

从类复制的说明: 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.

覆盖:

setIndependentActions 在类中 A_CmsRolesList

参数:

metadata - the list metadata

另请参阅:

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

setMultiActions

protected void setMultiActions(CmsListMetadata metadata)

从类复制的说明: 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.

指定者:

setMultiActions 在类中 A_CmsListDialog

参数:

metadata - the list metadata

另请参阅:

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