Package org.opencms.workplace.list
Class A_CmsListResourceTypeDialog
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.list.A_CmsListResourceTypeDialog
- Direct Known Subclasses:
CmsChtype
Super class for all dialogs needed to display a list of resource types.
- Since:
- 6.7.2
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringList independent action id constant.static final StringList column id constant.static final StringList column id constant.static final StringList column id constant.static final StringList detail description info.static final StringList id constant.static final StringRequest parameter name for the index page resource type.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
ConstructorsConstructorDescriptionA_CmsListResourceTypeDialog(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Public constructor with JSP variables.A_CmsListResourceTypeDialog(org.opencms.jsp.CmsJspActionElement jsp) Public constructor with JSP action element.A_CmsListResourceTypeDialog(org.opencms.jsp.CmsJspActionElement jsp, String listId, org.opencms.i18n.CmsMessageContainer listName, String sortedColId, CmsListOrderEnum sortOrder, String searchableColId) Public constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoidPerforms the dialog actions depending on the initialized action.protected StringReturns the html code to add directly before the list inside the form element.protected StringCan be overwritten to add some code after the list.protected StringCan be overwritten to add some code before the list.protected StringReturns the html code for the default action content.Builds a default button row with a continue and cancel button.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 paramSelectedType.paramsAsHidden(Collection<String> excludes) protected 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.voidsetParamSelectedType(String paramSelectedType) Sets the paramSelectedType.Methods inherited from class org.opencms.workplace.list.A_CmsListDialog
defaultActionHtml, defaultActionHtmlEnd, defaultActionHtmlStart, displayDialog, displayDialog, executeDefaultActions, executeListIndepActions, executeSearch, executeSelectPage, executeSort, fillList, getList, getListId, getListItems, 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, validateParamaters, 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, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, substituteSiteTitleStatic, switchToCurrentProject, switchToTempProject, updateUserPreferences
-
Field Details
-
LIST_ACTION_SEL
List independent action id constant.- See Also:
-
LIST_COLUMN_ICON
List column id constant.- See Also:
-
LIST_COLUMN_NAME
List column id constant.- See Also:
-
LIST_COLUMN_SELECT
List column id constant.- See Also:
-
LIST_DETAIL_DESCRIPTION
List detail description info.- See Also:
-
LIST_ID
List id constant.- See Also:
-
PARAM_SELECTED_TYPE
Request parameter name for the index page resource type.- See Also:
-
-
Constructor Details
-
A_CmsListResourceTypeDialog
Public constructor with JSP action element.- Parameters:
jsp- an initialized JSP action element
-
A_CmsListResourceTypeDialog
public A_CmsListResourceTypeDialog(org.opencms.jsp.CmsJspActionElement jsp, String listId, org.opencms.i18n.CmsMessageContainer listName, String sortedColId, CmsListOrderEnum sortOrder, String searchableColId) Public constructor.- Parameters:
jsp- an initialized JSP action elementlistId- the id of the displayed listlistName- the name of the listsortedColId- the a priory sorted columnsortOrder- the order of the sorted columnsearchableColId- the column to search into
-
A_CmsListResourceTypeDialog
public A_CmsListResourceTypeDialog(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
-
-
Method Details
-
actionDialog
public void actionDialog() throws javax.servlet.jsp.JspException, javax.servlet.ServletException, IOExceptionDescription copied from class:A_CmsListDialogPerforms the dialog actions depending on the initialized action.- Overrides:
actionDialogin classA_CmsListDialog- Throws:
javax.servlet.jsp.JspException- if dialog actions failjavax.servlet.ServletException- in case of errors forwarding to the required result pageIOException- in case of errors forwarding to the required result page- See Also:
-
dialogButtons
Builds a default button row with a continue and cancel button.Override this to have special buttons for your dialog.
- Returns:
- the button row
-
executeListMultiActions
Description copied from class:A_CmsListDialogThis 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- See Also:
-
executeListSingleActions
Description 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:
org.opencms.main.CmsRuntimeException- to signal that an action is not supported- See Also:
-
getParamSelectedType
Returns the paramSelectedType.- Returns:
- the paramSelectedType
-
paramsAsHidden
- Overrides:
paramsAsHiddenin classorg.opencms.workplace.CmsWorkplace- See Also:
-
paramsAsHidden
- Overrides:
paramsAsHiddenin classorg.opencms.workplace.CmsWorkplace- See Also:
-
setParamSelectedType
Sets the paramSelectedType.- Parameters:
paramSelectedType- the paramSelectedType to set
-
customHtmlBeforeList
Returns the html code to add directly before the list inside the form element.- Returns:
- the html code to add directly before the list inside the form element
-
customHtmlEnd
Description copied from class:A_CmsListDialogCan be overwritten to add some code after the list.- Overrides:
customHtmlEndin classA_CmsListDialog- Returns:
- custom html code
- See Also:
-
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:
-
defaultActionHtmlContent
Description copied from class:A_CmsListDialogReturns the html code for the default action content.- Overrides:
defaultActionHtmlContentin classA_CmsListDialog- Returns:
- 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:
-
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:
-