Class CmsGroupTransferList
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.CmsGroupTransferList
Allows to select a group to transfer the permissions and attributes from another one.
- Since:
- 6.0.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringlist action id constant.static final Stringlist column id constant.static final Stringlist column id constant.static final Stringlist column id constant.static final Stringlist column id constant.static final Stringlist column id constant.static final Stringlist column id constant.static final Stringlist action id constant.static final Stringlist item detail id constant.static final Stringlist item detail id constant.static final StringList id constant.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_COLFields 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_UPDATEFields inherited from class org.opencms.workplace.tools.CmsToolDialog
PARAM_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEWFields 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
ConstructorsModifierConstructorDescriptionprotectedCmsGroupTransferList(String listId, org.opencms.jsp.CmsJspActionElement jsp) Protected constructor.CmsGroupTransferList(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Public constructor with JSP variables.CmsGroupTransferList(org.opencms.jsp.CmsJspActionElement jsp) Public constructor. -
Method Summary
Modifier and TypeMethodDescriptionprotected StringCan be overwritten to add some code before the list.voidThis method should handle every defined list multi action, by comparingwith the id of the action to execute.A_CmsListDialog.getParamListAction()voidThis method should handle every defined list single action, by comparingwith the id of the action to execute.A_CmsListDialog.getParamListAction()protected voidfillDetails(String detailId) Lazy initialization for detail data.Returns the group Name.protected List<org.opencms.file.CmsGroup> Returns the list of groups to display.protected List<CmsListItem> Should generate a list with the list items to be displayed.Returns the group id parameter value.protected voidprotected voidsetColumns(CmsListMetadata metadata) Should create the columns and add them to the given list metadata object.protected voidsetIndependentActions(CmsListMetadata metadata) Should add the independent actions to the given list metadata object.protected voidsetMultiActions(CmsListMetadata metadata) Should add the multi actions to the given list metadata object.voidsetParamGroupid(String groupId) Sets the group id parameter value.protected voidsetTransferAction(CmsListColumnDefinition transferCol) Sets the icon actions for the transfer list.protected voidShould be overridden for parameter validation.Methods inherited from class org.opencms.workplace.list.A_CmsListDialog
actionDialog, customHtmlEnd, defaultActionHtml, defaultActionHtmlContent, defaultActionHtmlEnd, defaultActionHtmlStart, displayDialog, displayDialog, executeDefaultActions, executeListIndepActions, executeSearch, executeSelectPage, executeSort, fillList, getList, getListId, getListObject, getListState, getMetadata, getMetadata, getMetadataCache, 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, writeDialogMethods 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, setParamTitleMethods inherited from class 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, useNewStyleMethods 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, 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
-
Field Details
-
LIST_ACTION_TRANSFER
list action id constant.- See Also:
-
LIST_COLUMN_DESCRIPTION
list column id constant.- See Also:
-
LIST_COLUMN_DISPLAY
list column id constant.- See Also:
-
LIST_COLUMN_NAME
list column id constant.- See Also:
-
LIST_COLUMN_PARENT
list column id constant.- See Also:
-
LIST_COLUMN_TRANSFER
list column id constant.- See Also:
-
LIST_COLUMN_USERS
list column id constant.- See Also:
-
LIST_DEFACTION_TRANSFER
list action id constant.- See Also:
-
LIST_DETAIL_CHILDREN
list item detail id constant.- See Also:
-
LIST_DETAIL_USERS
list item detail id constant.- See Also:
-
LIST_ID
List id constant.- See Also:
-
-
Constructor Details
-
CmsGroupTransferList
Public constructor.- Parameters:
jsp- an initialized JSP action element
-
CmsGroupTransferList
public CmsGroupTransferList(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 contextreq- the JSP requestres- the JSP response
-
CmsGroupTransferList
Protected constructor.- Parameters:
listId- the id of the specialized listjsp- an initialized JSP action element
-
-
Method Details
-
executeListMultiActions
This method should handle every defined list multi action, by comparingwith the id of the action to execute.A_CmsListDialog.getParamListAction()- Specified by:
executeListMultiActionsin classA_CmsListDialog- Throws:
org.opencms.main.CmsRuntimeException- to signal that an action is not supported
-
executeListSingleActions
public void executeListSingleActions() throws IOException, javax.servlet.ServletException, org.opencms.main.CmsRuntimeExceptionDescription copied from class:A_CmsListDialogThis method should handle every defined list single action, by comparingwith the id of the action to execute.A_CmsListDialog.getParamListAction()- Specified by:
executeListSingleActionsin classA_CmsListDialog- Throws:
IOException- in case of errors when including a required sub-elementjavax.servlet.ServletException- in case of errors when including a required sub-elementorg.opencms.main.CmsRuntimeException- to signal that an action is not supported- See Also:
-
getGroupName
Returns the group Name.- Returns:
- the group Name
-
getParamGroupid
Returns the group id parameter value.- Returns:
- the group id parameter value
-
setParamGroupid
Sets the group id parameter value.- Parameters:
groupId- the group id parameter value
-
customHtmlStart
Description copied from class:A_CmsListDialogCan be overwritten to add some code before the list.- Overrides:
customHtmlStartin classA_CmsListDialog- Returns:
- custom html code
- See Also:
-
fillDetails
Description copied from class:A_CmsListDialogLazy initialization for detail data.Should fill the given detail column for every list item in
Should not throw any kind of exception.CmsHtmlList.getContent()- Specified by:
fillDetailsin classA_CmsListDialog- Parameters:
detailId- the id of the detail to initialize- See Also:
-
getGroups
Returns the list of groups to display.- Returns:
- the list of groups to display
- Throws:
org.opencms.main.CmsException- if something goes wrong
-
getListItems
Description copied from class:A_CmsListDialogShould generate a list with the list items to be displayed.- Specified by:
getListItemsin classA_CmsListDialog- Returns:
- a list of
sCmsListItem - Throws:
org.opencms.main.CmsException- if something goes wrong- See Also:
-
initMessages
- Overrides:
initMessagesin classorg.opencms.workplace.CmsWorkplace- See Also:
-
setColumns
Description copied from class:A_CmsListDialogShould 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:
setColumnsin classA_CmsListDialog- Parameters:
metadata- the list metadata- See Also:
-
setIndependentActions
Description copied from class:A_CmsListDialogShould 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:
setIndependentActionsin classA_CmsListDialog- Parameters:
metadata- the list metadata- See Also:
-
setMultiActions
Description copied from class:A_CmsListDialogShould 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:
setMultiActionsin classA_CmsListDialog- Parameters:
metadata- the list metadata- See Also:
-
setTransferAction
Sets the icon actions for the transfer list.- Parameters:
transferCol- the column to set the action
-
validateParamaters
Description copied from class:A_CmsListDialogShould be overridden for parameter validation.- Overrides:
validateParamatersin classA_CmsListDialog- Throws:
Exception- if the parameters are not valid- See Also:
-