org.opencms.workplace.list
Class A_CmsListExplorerDialog

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.list.A_CmsListExplorerDialog
Direct Known Subclasses:
A_CmsSelectResourceList, CmsDeleteBrokenRelationsList, CmsLockedResourcesList, CmsPublishBrokenRelationsList, CmsPublishResourcesList, CmsResourceLinkRelationList, CmsSearchResultsList, CmsShowSiblingsList

public abstract class A_CmsListExplorerDialog
extends A_CmsListDialog

Provides a list dialog for resources.

Since:
6.0.0
Version:
$Revision: 1.10 $
Author:
Michael Moossen

Field Summary
static java.lang.String LIST_ACTION_EDIT
          List action id constant.
static java.lang.String LIST_ACTION_LOCKICON
          List action id constant.
static java.lang.String LIST_ACTION_PROJSTATEICON
          List action id constant.
static java.lang.String LIST_ACTION_TYPEICON
          List action id constant.
static java.lang.String LIST_COLUMN_DATECREATE
          List column id constant.
static java.lang.String LIST_COLUMN_DATEEXP
          List column id constant.
static java.lang.String LIST_COLUMN_DATELASTMOD
          List column id constant.
static java.lang.String LIST_COLUMN_DATEREL
          List column id constant.
static java.lang.String LIST_COLUMN_EDIT
          List column id constant.
static java.lang.String LIST_COLUMN_LOCKEDBY
          List column id constant.
static java.lang.String LIST_COLUMN_LOCKICON
          List column id constant.
static java.lang.String LIST_COLUMN_NAME
          List column id constant.
static java.lang.String LIST_COLUMN_PERMISSIONS
          List column id constant.
static java.lang.String LIST_COLUMN_PROJSTATEICON
          List column id constant.
static java.lang.String LIST_COLUMN_ROOT_PATH
          List column id constant.
static java.lang.String LIST_COLUMN_SITE
          List column id constant.
static java.lang.String LIST_COLUMN_SIZE
          List column id constant.
static java.lang.String LIST_COLUMN_STATE
          List column id constant.
static java.lang.String LIST_COLUMN_TITLE
          List column id constant.
static java.lang.String LIST_COLUMN_TYPE
          List column id constant.
static java.lang.String LIST_COLUMN_TYPEICON
          List column id constant.
static java.lang.String LIST_COLUMN_USERCREATE
          List column id constant.
static java.lang.String LIST_COLUMN_USERLASTMOD
          List column id constant.
static java.lang.String LIST_DEFACTION_OPEN
          List default action id constant.
static java.lang.String PARAM_SHOW_EXPLORER
          Request parameter name for the show explorer flag.
static java.lang.String PATH_EXPLORER_LIST
          Explorer list JSP 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
protected A_CmsListExplorerDialog(CmsJspActionElement jsp, java.lang.String listId, CmsMessageContainer listName)
          Creates a new explorer list ordered and searchable by name.
protected A_CmsListExplorerDialog(CmsJspActionElement jsp, java.lang.String listId, CmsMessageContainer listName, java.lang.String sortedColId, CmsListOrderEnum sortOrder, java.lang.String searchableColId)
          Default constructor.
 
Method Summary
protected  void applyColumnVisibilities()
          Applies the column visibilities.
protected  java.lang.String defaultActionHtmlStart()
          Generates the dialog starting html code.
 void executeListIndepActions()
          This method should handle the default list independent actions, by comparing A_CmsListDialog.getParamListAction() with the id of the action to execute.
protected  void executeSelectPage()
          Select a page, given the action is set to LIST_SELECT_PAGE and the page to go to is set in the PARAM_PAGE parameter.
protected  void fillList()
          Calls the getListItems() method and catches any exception.
abstract  I_CmsListResourceCollector getCollector()
          Returns the collector to use to display the resources.
protected  java.util.Map getColVisibilities()
          Returns the colVisibilities map.
protected  java.util.List getListItems()
          Should generate a list with the list items to be displayed.
protected  CmsListState getListStateForCollector()
          Returns the list state for initializing the collector.
 java.lang.String getParamShowexplorer()
          Returns the Show explorer parameter value.
protected  CmsProject getProject()
          Returns the project to use as reference.
 CmsResourceUtil getResourceUtil()
          Returns an appropiate initialized resource util object.
 CmsResourceUtil getResourceUtil(CmsListItem item)
          Returns an appropiate initialized resource util object for the given item.
protected  void initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
          Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
protected  boolean isColumnVisible(int colFlag)
          Returns the visibility flag for a given column.
protected  void setColumns(CmsListMetadata metadata)
          Adds the standard explorer view columns to the list.
protected  void setColumnVisibilities()
          Sets the default column visibility flags from the user preferences.
protected  void setColumnVisibility(int colFlag, int prefs)
          Sets the given column visibility flag from the given preferences.
protected  void setColVisibilities(java.util.Map colVisibilities)
          Sets the colVisibilities map.
protected  void setIndependentActions(CmsListMetadata metadata)
          Should add the independent actions to the given list metadata object.
 void setParamShowexplorer(java.lang.String showExplorer)
          Sets the Show explorer parameter value.
 
Methods inherited from class org.opencms.workplace.list.A_CmsListDialog
actionDialog, customHtmlEnd, customHtmlStart, defaultActionHtml, defaultActionHtmlContent, defaultActionHtmlEnd, displayDialog, displayDialog, executeDefaultActions, executeListMultiActions, executeListSingleActions, executeSearch, executeSort, fillDetails, getList, getListId, getListObject, getListState, getMetadata, getMetadata, getParamFormName, getParamListAction, getParamPage, getParamSearchFilter, getParamSelItems, getParamSortCol, getSelectedItem, getSelectedItems, initializeDetail, isActive, listRecovery, listSave, refreshList, removeList, setList, setListObject, setMultiActions, 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_EDIT

public static final java.lang.String LIST_ACTION_EDIT
List action id constant.

See Also:
Constant Field Values

LIST_ACTION_LOCKICON

public static final java.lang.String LIST_ACTION_LOCKICON
List action id constant.

See Also:
Constant Field Values

LIST_ACTION_PROJSTATEICON

public static final java.lang.String LIST_ACTION_PROJSTATEICON
List action id constant.

See Also:
Constant Field Values

LIST_ACTION_TYPEICON

public static final java.lang.String LIST_ACTION_TYPEICON
List action id constant.

See Also:
Constant Field Values

LIST_COLUMN_DATECREATE

public static final java.lang.String LIST_COLUMN_DATECREATE
List column id constant.

See Also:
Constant Field Values

LIST_COLUMN_DATEEXP

public static final java.lang.String LIST_COLUMN_DATEEXP
List column id constant.

See Also:
Constant Field Values

LIST_COLUMN_DATELASTMOD

public static final java.lang.String LIST_COLUMN_DATELASTMOD
List column id constant.

See Also:
Constant Field Values

LIST_COLUMN_DATEREL

public static final java.lang.String LIST_COLUMN_DATEREL
List column id constant.

See Also:
Constant Field Values

LIST_COLUMN_EDIT

public static final java.lang.String LIST_COLUMN_EDIT
List column id constant.

See Also:
Constant Field Values

LIST_COLUMN_LOCKEDBY

public static final java.lang.String LIST_COLUMN_LOCKEDBY
List column id constant.

See Also:
Constant Field Values

LIST_COLUMN_LOCKICON

public static final java.lang.String LIST_COLUMN_LOCKICON
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_PERMISSIONS

public static final java.lang.String LIST_COLUMN_PERMISSIONS
List column id constant.

See Also:
Constant Field Values

LIST_COLUMN_PROJSTATEICON

public static final java.lang.String LIST_COLUMN_PROJSTATEICON
List column id constant.

See Also:
Constant Field Values

LIST_COLUMN_ROOT_PATH

public static final java.lang.String LIST_COLUMN_ROOT_PATH
List column id constant.

See Also:
Constant Field Values

LIST_COLUMN_SITE

public static final java.lang.String LIST_COLUMN_SITE
List column id constant.

See Also:
Constant Field Values

LIST_COLUMN_SIZE

public static final java.lang.String LIST_COLUMN_SIZE
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_COLUMN_TITLE

public static final java.lang.String LIST_COLUMN_TITLE
List column id constant.

See Also:
Constant Field Values

LIST_COLUMN_TYPE

public static final java.lang.String LIST_COLUMN_TYPE
List column id constant.

See Also:
Constant Field Values

LIST_COLUMN_TYPEICON

public static final java.lang.String LIST_COLUMN_TYPEICON
List column id constant.

See Also:
Constant Field Values

LIST_COLUMN_USERCREATE

public static final java.lang.String LIST_COLUMN_USERCREATE
List column id constant.

See Also:
Constant Field Values

LIST_COLUMN_USERLASTMOD

public static final java.lang.String LIST_COLUMN_USERLASTMOD
List column id constant.

See Also:
Constant Field Values

LIST_DEFACTION_OPEN

public static final java.lang.String LIST_DEFACTION_OPEN
List default action id constant.

See Also:
Constant Field Values

PARAM_SHOW_EXPLORER

public static final java.lang.String PARAM_SHOW_EXPLORER
Request parameter name for the show explorer flag.

See Also:
Constant Field Values

PATH_EXPLORER_LIST

public static final java.lang.String PATH_EXPLORER_LIST
Explorer list JSP path.

See Also:
Constant Field Values
Constructor Detail

A_CmsListExplorerDialog

protected A_CmsListExplorerDialog(CmsJspActionElement jsp,
                                  java.lang.String listId,
                                  CmsMessageContainer listName)
Creates a new explorer list ordered and searchable by name.

Parameters:
jsp - an initialized JSP action element
listId - the id of the displayed list
listName - the name of the list

A_CmsListExplorerDialog

protected A_CmsListExplorerDialog(CmsJspActionElement jsp,
                                  java.lang.String listId,
                                  CmsMessageContainer listName,
                                  java.lang.String sortedColId,
                                  CmsListOrderEnum sortOrder,
                                  java.lang.String searchableColId)
Default constructor.

Parameters:
jsp - an initialized JSP action element
listId - the id of the displayed list
listName - the name of the list
sortedColId - the a priory sorted column
sortOrder - the order of the sorted column
searchableColId - the column to search into
Method Detail

executeListIndepActions

public void executeListIndepActions()
Description copied from class: 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();.

Overrides:
executeListIndepActions in class A_CmsListDialog
See Also:
A_CmsListDialog.executeListIndepActions()

getCollector

public abstract I_CmsListResourceCollector getCollector()
Returns the collector to use to display the resources.

Returns:
the collector to use to display the resources

getParamShowexplorer

public java.lang.String getParamShowexplorer()
Returns the Show explorer parameter value.

Returns:
the Show explorer parameter value

getResourceUtil

public CmsResourceUtil getResourceUtil()
Returns an appropiate initialized resource util object.

Returns:
a resource util object

getResourceUtil

public CmsResourceUtil getResourceUtil(CmsListItem item)
Returns an appropiate initialized resource util object for the given item.

Parameters:
item - the item representing the resource
Returns:
a resource util object

setParamShowexplorer

public void setParamShowexplorer(java.lang.String showExplorer)
Sets the Show explorer parameter value.

Parameters:
showExplorer - the Show explorer parameter value to set

applyColumnVisibilities

protected void applyColumnVisibilities()
Applies the column visibilities.


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

executeSelectPage

protected void executeSelectPage()
Description copied from class: A_CmsListDialog
Select a page, given the action is set to LIST_SELECT_PAGE and the page to go to is set in the PARAM_PAGE parameter.

Overrides:
executeSelectPage in class A_CmsListDialog
See Also:
A_CmsListDialog.executeSelectPage()

fillList

protected void fillList()
Description copied from class: A_CmsListDialog
Calls the A_CmsListDialog.getListItems() method and catches any exception.

Overrides:
fillList in class A_CmsListDialog
See Also:
A_CmsListDialog.fillList()

getColVisibilities

protected java.util.Map getColVisibilities()
Returns the colVisibilities map.

Returns:
the colVisibilities map

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

getListStateForCollector

protected CmsListState getListStateForCollector()
Returns the list state for initializing the collector.

Returns:
the list state

getProject

protected CmsProject getProject()
Returns the project to use as reference.

Returns:
the project to use as reference

initWorkplaceRequestValues

protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings,
                                          javax.servlet.http.HttpServletRequest request)
Description copied from class: CmsWorkplace
Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.

Overrides:
initWorkplaceRequestValues in class A_CmsListDialog
See Also:
CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)

isColumnVisible

protected boolean isColumnVisible(int colFlag)
Returns the visibility flag for a given column.

The default behavior is to show the same columns as the explorer view, but this can be overwritten.

Parameters:
colFlag - some CmsUserSettings.FILELIST_TITLE like value identifying the column to get the visibility flag for
Returns:
the visibility flag for the given column

setColumns

protected void setColumns(CmsListMetadata metadata)
Adds the standard explorer view columns to the list.

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

setColumnVisibilities

protected void setColumnVisibilities()
Sets the default column visibility flags from the user preferences.


setColumnVisibility

protected void setColumnVisibility(int colFlag,
                                   int prefs)
Sets the given column visibility flag from the given preferences.

Parameters:
colFlag - the flag that identifies the column to set the flag for
prefs - the user preferences

setColVisibilities

protected void setColVisibilities(java.util.Map colVisibilities)
Sets the colVisibilities map.

Parameters:
colVisibilities - the colVisibilities map to set

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)