org.opencms.workplace.commons
Class A_CmsResourceCategoriesList

java.lang.Object
  extended byorg.opencms.workplace.CmsWorkplace
      extended byorg.opencms.workplace.tools.CmsToolDialog
          extended byorg.opencms.workplace.CmsDialog
              extended byorg.opencms.workplace.list.A_CmsListDialog
                  extended byorg.opencms.workplace.commons.A_CmsResourceCategoriesList
Direct Known Subclasses:
CmsNotResourceCategoriesList, CmsResourceCategoriesList

public abstract class A_CmsResourceCategoriesList
extends A_CmsListDialog

Generalized resource categories view.

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

Field Summary
static java.lang.String LIST_ACTION_ICON
          list action 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_PATH
          list column id constant.
static java.lang.String LIST_COLUMN_STATE
          list column id constant.
static java.lang.String LIST_DETAIL_DESCRIPTION
          list item detail id constant.
static java.lang.String LIST_DETAIL_PATH
          list item detail 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, 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
protected A_CmsResourceCategoriesList(CmsJspActionElement jsp, java.lang.String listId, CmsMessageContainer listName, boolean searchable)
          Public constructor.
 
Method Summary
 void executeListMultiActions()
          This method should handle every defined list multi 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.
protected abstract  java.util.List getCategories()
          Returns a list of categories to display.
protected  CmsCategoryService getCategoryService()
          Returns the categoryService.
protected  java.util.List getListItems()
          Should generate a list with the list items to be displayed.
protected  java.util.List getResourceCategories()
          Returns a list of a categories related to the current request resource.
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.
protected abstract  void setStateActionCol(CmsListMetadata metadata)
          Sets the optional state change action column.
 
Methods inherited from class org.opencms.workplace.list.A_CmsListDialog
actionDialog, customHtmlEnd, customHtmlStart, defaultActionHtml, defaultActionHtmlContent, defaultActionHtmlEnd, defaultActionHtmlStart, displayDialog, displayDialog, executeDefaultActions, executeListIndepActions, executeListSingleActions, 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_ICON

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

See Also:
Constant Field Values

LIST_COLUMN_ICON

public static final java.lang.String LIST_COLUMN_ICON
list column id constant.

See Also:
Constant Field Values

LIST_COLUMN_NAME

public static final java.lang.String LIST_COLUMN_NAME
list column id constant.

See Also:
Constant Field Values

LIST_COLUMN_PATH

public static final java.lang.String LIST_COLUMN_PATH
list column id constant.

See Also:
Constant Field Values

LIST_COLUMN_STATE

public static final java.lang.String LIST_COLUMN_STATE
list column id constant.

See Also:
Constant Field Values

LIST_DETAIL_DESCRIPTION

public static final java.lang.String LIST_DETAIL_DESCRIPTION
list item detail id constant.

See Also:
Constant Field Values

LIST_DETAIL_PATH

public static final java.lang.String LIST_DETAIL_PATH
list item detail id constant.

See Also:
Constant Field Values
Constructor Detail

A_CmsResourceCategoriesList

protected A_CmsResourceCategoriesList(CmsJspActionElement jsp,
                                      java.lang.String listId,
                                      CmsMessageContainer listName,
                                      boolean searchable)
Public constructor.

Parameters:
jsp - an initialized JSP action element
listId - the id of the list
listName - the name of the list
searchable - searchable flag
Method Detail

executeListMultiActions

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

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

fillDetails

protected void fillDetails(java.lang.String detailId)
Description copied from class: 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.

Specified by:
fillDetails in class A_CmsListDialog
Parameters:
detailId - the id of the detail to initialize
See Also:
A_CmsListDialog.fillDetails(java.lang.String)

getCategories

protected abstract java.util.List getCategories()
                                         throws CmsException
Returns a list of categories to display.

Returns:
a list of categories
Throws:
CmsException - if something goes wrong

getCategoryService

protected CmsCategoryService getCategoryService()
Returns the categoryService.

Returns:
the categoryService

getListItems

protected java.util.List getListItems()
                               throws CmsException
Description copied from class: A_CmsListDialog
Should generate a list with the list items to be displayed.

Specified by:
getListItems in class A_CmsListDialog
Returns:
a list of CmsListItems
Throws:
CmsException - if something goes wrong
See Also:
A_CmsListDialog.getListItems()

getResourceCategories

protected java.util.List getResourceCategories()
                                        throws CmsException
Returns a list of a categories related to the current request resource.

Returns:
a list of a categories related to the current request resource
Throws:
CmsException - if something goes wrong

setColumns

protected void setColumns(CmsListMetadata metadata)
Description copied from class: 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.

Specified by:
setColumns in class A_CmsListDialog
Parameters:
metadata - the list metadata
See Also:
A_CmsListDialog.setColumns(org.opencms.workplace.list.CmsListMetadata)

setIndependentActions

protected void setIndependentActions(CmsListMetadata metadata)
Description copied from class: 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.

Specified by:
setIndependentActions in class A_CmsListDialog
Parameters:
metadata - the list metadata
See Also:
A_CmsListDialog.setIndependentActions(org.opencms.workplace.list.CmsListMetadata)

setMultiActions

protected void setMultiActions(CmsListMetadata metadata)
Description copied from class: 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.

Specified by:
setMultiActions in class A_CmsListDialog
Parameters:
metadata - the list metadata
See Also:
A_CmsListDialog.setMultiActions(org.opencms.workplace.list.CmsListMetadata)

setStateActionCol

protected abstract void setStateActionCol(CmsListMetadata metadata)
Sets the optional state change action column.

Parameters:
metadata - the list metadata object