org.opencms.workplace.tools.accounts

类 A_CmsGroupUsersList

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_CmsGroupUsersList

直接已知子类:

CmsGroupUsersList, CmsNotGroupUsersList, CmsShowGroupUsersList

public abstract class A_CmsGroupUsersList
extends A_CmsListDialog

Generalized user groups view.

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	LIST_ACTION_ICON list action id constant.
static java.lang.String	LIST_ACTION_STATE list action id constant.
static java.lang.String	LIST_COLUMN_FULLNAME list column id constant.
static java.lang.String	LIST_COLUMN_ICON list column id constant.
static java.lang.String	LIST_COLUMN_LOGIN list column id constant.
static java.lang.String	LIST_COLUMN_NAME list column id constant.
static java.lang.String	LIST_COLUMN_ORGUNIT list column id constant.
static java.lang.String	LIST_COLUMN_STATE list column id constant.
static java.lang.String	LIST_DETAIL_OTHEROU list item detail id constant.

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

构造器概要

构造器

限定符	构造器和说明
protected	A_CmsGroupUsersList(CmsJspActionElement jsp, java.lang.String listId, CmsMessageContainer listName, boolean searchable) Public constructor.
protected	A_CmsGroupUsersList(CmsJspActionElement jsp, java.lang.String listId, CmsMessageContainer listName, boolean searchable, boolean lazy) Public constructor.

方法概要

方法

限定符和类型	方法和说明
void	actionDialog() Performs the dialog actions depending on the initialized action.
protected void	fillDetails(java.lang.String detailId) Lazy initialization for detail data.
java.lang.String	getIconPath(CmsListItem item) Returns the right icon path for the given list item.
protected java.util.List<CmsListItem>	getListItems() Should generate a list with the list items to be displayed.
java.lang.String	getParamGroupid() Returns the user id parameter value.
java.lang.String	getParamGroupname() Returns the Group name parameter.
java.lang.String	getParamOufqn() Returns the organizational unit fqn parameter value.
protected abstract java.util.List<CmsUser>	getUsers(boolean withOtherOus) Returns a list of users to display.
protected boolean	hasOuDetail() Checks whether users of other OUs should be shown.
boolean	hasUsersInOtherOus() Returns true if the list of users has users of other organizational units.
protected void	initializeDetail(java.lang.String detailId) Lazy details initialization.
protected void	initMessages() Initializes the message object.
protected CmsListItem	makeListItem(CmsUser user) Makes a list item from a user.
protected CmsListItem	makeListItemForUser(CmsUser user) Makes a list item for a given user.
protected void	setColumns(CmsListMetadata metadata) Should create the columns and add them to the given list metadata object.
protected abstract void	setDefaultAction(CmsListColumnDefinition loginCol) Sets the optional login default action.
protected abstract void	setIconAction(CmsListColumnDefinition iconCol) Sets the needed icon action(s).
protected void	setIndependentActions(CmsListMetadata metadata) Should add the independent actions to the given list metadata object.
void	setParamGroupid(java.lang.String userId) Sets the user id parameter value.
void	setParamOufqn(java.lang.String ouFqn) Sets the organizational unit fqn parameter value.
protected abstract void	setStateActionCol(CmsListMetadata metadata) Sets the optional state change action column.
protected void	setUserData(CmsUser user, CmsListItem item) Sets all needed data of the user into the list item object.
void	updateGroupList() Updates the main user list.
protected void	validateParamaters() Should be overridden for parameter validation.

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

customHtmlEnd, customHtmlStart, defaultActionHtml, defaultActionHtmlContent, defaultActionHtmlEnd, defaultActionHtmlStart, displayDialog, displayDialog, executeDefaultActions, executeListIndepActions, executeListMultiActions, executeListSingleActions, executeSearch, executeSelectPage, executeSort, fillList, getList, getListId, getListObject, getListState, getMetadata, getMetadata, getParamFormName, getParamListAction, getParamPage, getParamSearchFilter, getParamSelItems, getParamSortCol, getSelectedItem, getSelectedItems, initWorkplaceRequestValues, isActive, listRecovery, listSave, refreshList, removeList, setList, setListObject, setMultiActions, 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, 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_ACTION_ICON

public static final java.lang.String LIST_ACTION_ICON

list action id constant.

另请参阅:

常量字段值

LIST_ACTION_STATE

public static final java.lang.String LIST_ACTION_STATE

list action id constant.

另请参阅:

常量字段值

LIST_COLUMN_FULLNAME

public static final java.lang.String LIST_COLUMN_FULLNAME

list column id constant.

另请参阅:

常量字段值

LIST_COLUMN_ICON

public static final java.lang.String LIST_COLUMN_ICON

list column id constant.

另请参阅:

常量字段值

LIST_COLUMN_LOGIN

public static final java.lang.String LIST_COLUMN_LOGIN

list column id constant.

另请参阅:

常量字段值

LIST_COLUMN_NAME

public static final java.lang.String LIST_COLUMN_NAME

list column id constant.

另请参阅:

常量字段值

LIST_COLUMN_ORGUNIT

public static final java.lang.String LIST_COLUMN_ORGUNIT

list column id constant.

另请参阅:

常量字段值

LIST_COLUMN_STATE

public static final java.lang.String LIST_COLUMN_STATE

list column id constant.

另请参阅:

常量字段值

LIST_DETAIL_OTHEROU

public static final java.lang.String LIST_DETAIL_OTHEROU

list item detail id constant.

另请参阅:

常量字段值

构造器详细资料

A_CmsGroupUsersList

protected A_CmsGroupUsersList(CmsJspActionElement jsp,
                   java.lang.String listId,
                   CmsMessageContainer listName,
                   boolean searchable)

Public constructor.

参数:

jsp - an initialized JSP action element

listId - the id of the list

listName - the name of the list

searchable - searchable flag

A_CmsGroupUsersList

protected A_CmsGroupUsersList(CmsJspActionElement jsp,
                   java.lang.String listId,
                   CmsMessageContainer listName,
                   boolean searchable,
                   boolean lazy)

Public constructor.

参数:

jsp - an initialized JSP action element

listId - the id of the list

listName - the name of the list

searchable - searchable flag

lazy - the lazy flag

方法详细资料

actionDialog

public void actionDialog()
                  throws javax.servlet.jsp.JspException,
                         javax.servlet.ServletException,
                         java.io.IOException

从类复制的说明: A_CmsListDialog

Performs the dialog actions depending on the initialized action.

覆盖:

actionDialog 在类中 A_CmsListDialog

抛出:

javax.servlet.jsp.JspException - if dialog actions fail

javax.servlet.ServletException - in case of errors forwarding to the required result page

java.io.IOException - in case of errors forwarding to the required result page

另请参阅:

A_CmsListDialog.actionDialog()

getParamGroupid

public java.lang.String getParamGroupid()

Returns the user id parameter value.

返回:

the user id parameter value

getParamGroupname

public java.lang.String getParamGroupname()

Returns the Group name parameter.

返回:

the Group name parameter

getIconPath

public java.lang.String getIconPath(CmsListItem item)

Returns the right icon path for the given list item.

参数:

item - the list item to get the icon path for

返回:

the icon path for the given role

getParamOufqn

public java.lang.String getParamOufqn()

Returns the organizational unit fqn parameter value.

返回:

the organizational unit fqn parameter value

hasUsersInOtherOus

public boolean hasUsersInOtherOus()

Returns true if the list of users has users of other organizational units.

返回:

true if the list of users has users of other organizational units

makeListItemForUser

protected CmsListItem makeListItemForUser(CmsUser user)

Makes a list item for a given user.

参数:

user - the user

返回:

the list item

setParamGroupid

public void setParamGroupid(java.lang.String userId)

Sets the user id parameter value.

参数:

userId - the user id parameter value

setParamOufqn

public void setParamOufqn(java.lang.String ouFqn)

Sets the organizational unit fqn parameter value.

参数:

ouFqn - the organizational unit fqn parameter value

updateGroupList

public void updateGroupList()

Updates the main user list.

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_CmsListDialog

参数:

detailId - the id of the detail to initialize

另请参阅:

A_CmsListDialog.fillDetails(java.lang.String)

hasOuDetail

protected boolean hasOuDetail()

Checks whether users of other OUs should be shown.

返回:

true if users of other OUs should be shown

getListItems

protected java.util.List<CmsListItem> getListItems()
                                            throws CmsException

从类复制的说明: A_CmsListDialog

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

指定者:

getListItems 在类中 A_CmsListDialog

返回:

a list of CmsListItems

抛出:

CmsException - if something goes wrong

另请参阅:

A_CmsListDialog.getListItems()

makeListItem

protected CmsListItem makeListItem(CmsUser user)

Makes a list item from a user.

参数:

user - a user

返回:

a list item

setUserData

protected void setUserData(CmsUser user,
               CmsListItem item)

Sets all needed data of the user into the list item object.

参数:

user - the user to set the data for

item - the list item object to set the data into

getUsers

protected abstract java.util.List<CmsUser> getUsers(boolean withOtherOus)
                                             throws CmsException

Returns a list of users to display.

参数:

withOtherOus - if not set only users of the current ou should be returned

返回:

a list of <CmsUsers

抛出:

CmsException - if something goes wrong

initializeDetail

protected void initializeDetail(java.lang.String detailId)

从类复制的说明: A_CmsListDialog

Lazy details initialization.

覆盖:

initializeDetail 在类中 A_CmsListDialog

参数:

detailId - the id of the detail column

另请参阅:

A_CmsListDialog.initializeDetail(java.lang.String)

initMessages

protected void initMessages()

从类复制的说明: CmsWorkplace

Initializes the message object.

By default the CmsWorkplaceMessages are initialized.

You SHOULD override this method for setting the bundles you really need, using the CmsWorkplace.addMessages(CmsMessages) or CmsWorkplace.addMessages(String) method.

覆盖:

initMessages 在类中 CmsWorkplace

另请参阅:

CmsWorkplace.initMessages()

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_CmsListDialog

参数:

metadata - the list metadata

另请参阅:

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

setDefaultAction

protected abstract void setDefaultAction(CmsListColumnDefinition loginCol)

Sets the optional login default action.

参数:

loginCol - the login column

setIconAction

protected abstract void setIconAction(CmsListColumnDefinition iconCol)

Sets the needed icon action(s).

参数:

iconCol - the list column for edition.

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_CmsListDialog

参数:

metadata - the list metadata

另请参阅:

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

setStateActionCol

protected abstract void setStateActionCol(CmsListMetadata metadata)

Sets the optional state change action column.

参数:

metadata - the list metadata object

validateParamaters

protected void validateParamaters()
                           throws java.lang.Exception

从类复制的说明: A_CmsListDialog

Should be overridden for parameter validation.

覆盖:

validateParamaters 在类中 A_CmsListDialog

抛出:

java.lang.Exception - if the parameters are not valid

另请参阅:

A_CmsListDialog.validateParamaters()