org.opencms.workplace.commons

类 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.

从以下版本开始:

6.5.6

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	LIST_ACTION_ICON list action id constant.
static java.lang.String	LIST_ACTION_SELECT list action id constant.
static java.lang.String	LIST_COLUMN_DESCRIPTION list column id constant.
static java.lang.String	LIST_COLUMN_DISPLAY list column id constant.
static java.lang.String	LIST_COLUMN_ICON 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_DETAIL_OTHEROU list item detail id constant.
static java.lang.String	LIST_IACTION_GROUPS list action id constant.
static java.lang.String	LIST_IACTION_USERS list action id constant.
static java.lang.String	LIST_ID list id constant.
static java.lang.String	PATH_BUTTONS Path to the list 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

构造器概要

构造器

构造器和说明
CmsPrincipalSelectionList(CmsJspActionElement jsp) Public constructor.
CmsPrincipalSelectionList(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Public constructor with JSP variables.

方法概要

方法

限定符和类型	方法和说明
java.lang.String	dialogTitle() Generates the standard new style dialog title row, and tool grouping.
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(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	getListItems() Should generate a list with the list items to be displayed.
java.lang.String	getParamFlags() Returns the flags parameter value.
java.lang.String	getParamUseparent() Returns the use parent frame flag.
protected java.util.List	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(java.lang.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(java.lang.String flags) Sets the flags parameter value.
void	setParamUseparent(java.lang.String useParent) Sets the use parent frame flag.
protected void	validateParamaters() Should be overridden for parameter validation.

从类继承的方法 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, 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

从类继承的方法 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, 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_ACTION_ICON

public static final java.lang.String LIST_ACTION_ICON

list action id constant.

另请参阅:

常量字段值

LIST_ACTION_SELECT

public static final java.lang.String LIST_ACTION_SELECT

list action id constant.

另请参阅:

常量字段值

LIST_COLUMN_DESCRIPTION

public static final java.lang.String LIST_COLUMN_DESCRIPTION

list column id constant.

另请参阅:

常量字段值

LIST_COLUMN_DISPLAY

public static final java.lang.String LIST_COLUMN_DISPLAY

list column id constant.

另请参阅:

常量字段值

LIST_COLUMN_ICON

public static final java.lang.String LIST_COLUMN_ICON

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_DETAIL_OTHEROU

public static final java.lang.String LIST_DETAIL_OTHEROU

list item detail id constant.

另请参阅:

常量字段值

LIST_IACTION_GROUPS

public static final java.lang.String LIST_IACTION_GROUPS

list action id constant.

另请参阅:

常量字段值

LIST_IACTION_USERS

public static final java.lang.String LIST_IACTION_USERS

list action id constant.

另请参阅:

常量字段值

LIST_ID

public static final java.lang.String LIST_ID

list id constant.

另请参阅:

常量字段值

PATH_BUTTONS

public static final java.lang.String PATH_BUTTONS

Path to the list buttons.

另请参阅:

常量字段值

构造器详细资料

CmsPrincipalSelectionList

public CmsPrincipalSelectionList(CmsJspActionElement jsp)

Public constructor.

参数:

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.

参数:

context - the JSP page context

req - the JSP request

res - the JSP response

方法详细资料

dialogTitle

public java.lang.String dialogTitle()

从类复制的说明: CmsToolDialog

Generates the standard new style dialog title row, and tool grouping.

It is called by the CmsDialog.dialog(int, String) method.

覆盖:

dialogTitle 在类中 CmsToolDialog

返回:

a dialog window start / end segment

另请参阅:

CmsToolDialog.dialogTitle()

executeListIndepActions

public void executeListIndepActions()

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

覆盖:

executeListIndepActions 在类中 A_CmsListDialog

另请参阅:

A_CmsListDialog.executeListIndepActions()

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 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

抛出:

CmsRuntimeException - to signal that an action is not supported

另请参阅:

A_CmsListDialog.executeListSingleActions()

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

getParamFlags

public java.lang.String getParamFlags()

Returns the flags parameter value.

返回:

the flags parameter value

getParamUseparent

public java.lang.String getParamUseparent()

Returns the use parent frame flag.

返回:

the use parent frame flag

hasPrincipalsInOtherOus

public boolean hasPrincipalsInOtherOus()

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

返回:

if the list of principals has principals of other organizational units

isShowingUsers

public boolean isShowingUsers()

Checks if we are currently displaying users or groups.

返回:

true if we are currently displaying users

setParamFlags

public void setParamFlags(java.lang.String flags)

Sets the flags parameter value.

参数:

flags - the flags parameter value to set

setParamUseparent

public void setParamUseparent(java.lang.String useParent)

Sets the use parent frame flag.

参数:

useParent - the use parent frame flag

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)

getListItems

protected java.util.List 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()

getPrincipals

protected java.util.List getPrincipals(boolean includeOtherOus)
                                throws CmsException

Returns the list of principals for selection.

参数:

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

返回:

a list of principals

抛出:

CmsException - if womething 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)

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)

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)

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)

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()