org.opencms.workplace.commons
Class CmsResourceCategoriesList

java.lang.Object
  extended by org.opencms.workplace.CmsWorkplace
      extended by org.opencms.workplace.tools.CmsToolDialog
          extended by org.opencms.workplace.CmsDialog
              extended by org.opencms.workplace.list.A_CmsListDialog
                  extended by org.opencms.workplace.commons.A_CmsResourceCategoriesList
                      extended by org.opencms.workplace.commons.CmsResourceCategoriesList

public class CmsResourceCategoriesList
extends A_CmsResourceCategoriesList

Resource categories view.

Since:
6.9.2
Version:
$Revision: 1.3 $
Author:
Raphael Schnuck

Field Summary
static java.lang.String LIST_ACTION_REMOVE
          list action id constant.
static java.lang.String LIST_ID
          list id constant.
static java.lang.String LIST_MACTION_REMOVE
          list action id constant.
 
Fields inherited from class org.opencms.workplace.commons.A_CmsResourceCategoriesList
LIST_ACTION_ICON, LIST_COLUMN_ICON, LIST_COLUMN_NAME, LIST_COLUMN_PATH, LIST_COLUMN_STATE, LIST_DETAIL_DESCRIPTION, LIST_DETAIL_PATH
 
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, LIST_INDEPENDENT_ACTION, LIST_MULTI_ACTION, LIST_SEARCH, LIST_SELECT_PAGE, LIST_SINGLE_ACTION, LIST_SORT, PARAM_FORMNAME, PARAM_LIST_ACTION, PARAM_PAGE, PARAM_SEARCH_FILTER, PARAM_SEL_ITEMS, PARAM_SORT_COL
 
Fields 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_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
 
Fields inherited from class org.opencms.workplace.tools.CmsToolDialog
PARAM_BASE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW
 
Fields inherited from class 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, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, TEMP_FILE_PREFIX, 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
 
Constructor Summary
  CmsResourceCategoriesList(CmsJspActionElement jsp)
          Public constructor.
protected CmsResourceCategoriesList(CmsJspActionElement jsp, java.lang.String listId)
          Protected constructor.
  CmsResourceCategoriesList(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
          Public constructor with JSP variables.
 
Method Summary
protected  java.lang.String defaultActionHtmlStart()
          Generates the dialog starting html code.
 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  java.util.List getCategories()
          Returns a list of categories to display.
protected  void setStateActionCol(CmsListMetadata metadata)
          Sets the optional state change action column.
 
Methods inherited from class org.opencms.workplace.commons.A_CmsResourceCategoriesList
executeListMultiActions, fillDetails, getCategoryService, getListItems, getResourceCategories, setColumns, setIndependentActions, setMultiActions
 
Methods inherited from class org.opencms.workplace.list.A_CmsListDialog
actionDialog, customHtmlEnd, customHtmlStart, defaultActionHtml, defaultActionHtmlContent, defaultActionHtmlEnd, 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, validateParamaters, writeDialog
 
Methods inherited from class 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
 
Methods inherited from class org.opencms.workplace.tools.CmsToolDialog
dialogTitle, getAdminTool, getCurrentToolPath, getParamBase, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, setParamPath, setParamRoot, setParamStyle, useNewStyle
 
Methods 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, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, htmlEnd, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, isTemporaryFileName, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, switchToCurrentProject, switchToTempProject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LIST_ACTION_REMOVE

public static final java.lang.String LIST_ACTION_REMOVE
list action id constant.

See Also:
Constant Field Values

LIST_ID

public static final java.lang.String LIST_ID
list id constant.

See Also:
Constant Field Values

LIST_MACTION_REMOVE

public static final java.lang.String LIST_MACTION_REMOVE
list action id constant.

See Also:
Constant Field Values
Constructor Detail

CmsResourceCategoriesList

public CmsResourceCategoriesList(CmsJspActionElement jsp)
Public constructor.

Parameters:
jsp - an initialized JSP action element

CmsResourceCategoriesList

public CmsResourceCategoriesList(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 context
req - the JSP request
res - the JSP response

CmsResourceCategoriesList

protected CmsResourceCategoriesList(CmsJspActionElement jsp,
                                    java.lang.String listId)
Protected constructor.

Parameters:
jsp - an initialized JSP action element
listId - the id of the specialized list
Method Detail

executeListSingleActions

public void executeListSingleActions()
                              throws CmsRuntimeException
Description copied from class: A_CmsListDialog
This method should handle every defined list single action, by comparing A_CmsListDialog.getParamListAction() with the id of the action to execute.

Specified by:
executeListSingleActions in class A_CmsListDialog
Throws:
CmsRuntimeException - to signal that an action is not supported
See Also:
A_CmsListDialog.executeListSingleActions()

defaultActionHtmlStart

protected java.lang.String defaultActionHtmlStart()
Description copied from class: A_CmsListDialog
Generates the dialog starting html code.

Overrides:
defaultActionHtmlStart in class A_CmsListDialog
Returns:
html code
See Also:
A_CmsListDialog.defaultActionHtmlStart()

getCategories

protected java.util.List getCategories()
                                throws CmsException
Description copied from class: A_CmsResourceCategoriesList
Returns a list of categories to display.

Specified by:
getCategories in class A_CmsResourceCategoriesList
Returns:
a list of categories
Throws:
CmsException - if something goes wrong
See Also:
A_CmsResourceCategoriesList.getCategories()

setStateActionCol

protected void setStateActionCol(CmsListMetadata metadata)
Description copied from class: A_CmsResourceCategoriesList
Sets the optional state change action column.

Specified by:
setStateActionCol in class A_CmsResourceCategoriesList
Parameters:
metadata - the list metadata object
See Also:
A_CmsResourceCategoriesList.setStateActionCol(org.opencms.workplace.list.CmsListMetadata)