Package org.opencms.workplace.list
Class A_CmsListExplorerDialog
- 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_CmsListExplorerDialog
-
- Direct Known Subclasses:
A_CmsSelectResourceList
,CmsContentCheckFilesDialog
,CmsDeleteBrokenRelationsList
,CmsInternalLinkValidationList
,CmsLockedResourcesList
,CmsProjectFilesDialog
,CmsPublishBrokenRelationsList
,CmsPublishResourcesList
,CmsResourceLinkRelationList
,CmsSearchResultsList
,CmsShowOrgUnitResourceList
,CmsShowSiblingsList
,CmsSourceSearchFilesDialog
public abstract class A_CmsListExplorerDialog extends A_CmsListDialog
Provides a list dialog for resources.- Since:
- 6.0.0
-
-
Field Summary
Fields Modifier and Type Field Description 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, 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_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_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_UPDATE
-
Fields inherited from class org.opencms.workplace.tools.CmsToolDialog
PARAM_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW
-
Fields 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
Constructors Modifier Constructor Description protected
A_CmsListExplorerDialog(org.opencms.jsp.CmsJspActionElement jsp, java.lang.String listId, org.opencms.i18n.CmsMessageContainer listName)
Creates a new explorer list ordered and searchable by name.protected
A_CmsListExplorerDialog(org.opencms.jsp.CmsJspActionElement jsp, java.lang.String listId, org.opencms.i18n.CmsMessageContainer listName, java.lang.String sortedColId, CmsListOrderEnum sortOrder, java.lang.String searchableColId)
Default constructor.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description 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
with the id of the action to execute.A_CmsListDialog.getParamListAction()
protected void
executeSelectPage()
Select a page, given the action is set toLIST_SELECT_PAGE
and the page to go to is set in thePARAM_PAGE
parameter.protected void
fillList()
Calls the
method and catches any exception.A_CmsListDialog.getListItems()
protected java.util.Map<java.lang.String,java.lang.String[]>
getAdditionalParametersForExplorerForward()
Gets a map of additional request parameters which should be passed to the explorer.abstract I_CmsListResourceCollector
getCollector()
Returns the collector to use to display the resources.protected java.util.Map<java.lang.Integer,java.lang.Boolean>
getColVisibilities()
Returns the colVisibilities map.protected java.util.List<CmsListItem>
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 org.opencms.file.CmsProject
getProject()
Returns the project to use as reference.org.opencms.workplace.explorer.CmsResourceUtil
getResourceUtil()
Returns an appropiate initialized resource util object.org.opencms.workplace.explorer.CmsResourceUtil
getResourceUtil(CmsListItem item)
Returns an appropiate initialized resource util object for the given item.protected void
initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
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<java.lang.Integer,java.lang.Boolean> 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, getMetadataCache, 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, 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, setParamTitle
-
Methods 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, 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, 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, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, substituteSiteTitleStatic, switchToCurrentProject, switchToTempProject, updateUserPreferences
-
-
-
-
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(org.opencms.jsp.CmsJspActionElement jsp, java.lang.String listId, org.opencms.i18n.CmsMessageContainer listName)
Creates a new explorer list ordered and searchable by name.- Parameters:
jsp
- an initialized JSP action elementlistId
- the id of the displayed listlistName
- the name of the list
-
A_CmsListExplorerDialog
protected A_CmsListExplorerDialog(org.opencms.jsp.CmsJspActionElement jsp, java.lang.String listId, org.opencms.i18n.CmsMessageContainer listName, java.lang.String sortedColId, CmsListOrderEnum sortOrder, java.lang.String searchableColId)
Default 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
-
-
Method Detail
-
executeListIndepActions
public void executeListIndepActions()
Description copied from class:A_CmsListDialog
This method should handle the default list independent actions, by comparing
with the id of the action to execute.A_CmsListDialog.getParamListAction()
if you want to handle additional independent actions, override this method, handling your actions and FINALLY calling
super.executeListIndepActions();
.- Overrides:
executeListIndepActions
in classA_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 org.opencms.workplace.explorer.CmsResourceUtil getResourceUtil()
Returns an appropiate initialized resource util object.- Returns:
- a resource util object
-
getResourceUtil
public org.opencms.workplace.explorer.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 classA_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 toLIST_SELECT_PAGE
and the page to go to is set in thePARAM_PAGE
parameter.- Overrides:
executeSelectPage
in classA_CmsListDialog
- See Also:
A_CmsListDialog.executeSelectPage()
-
fillList
protected void fillList()
Description copied from class:A_CmsListDialog
Calls the
method and catches any exception.A_CmsListDialog.getListItems()
- Overrides:
fillList
in classA_CmsListDialog
- See Also:
A_CmsListDialog.fillList()
-
getAdditionalParametersForExplorerForward
protected java.util.Map<java.lang.String,java.lang.String[]> getAdditionalParametersForExplorerForward()
Gets a map of additional request parameters which should be passed to the explorer.- Returns:
- the map of additional parameters to pass to the explorer
-
getColVisibilities
protected java.util.Map<java.lang.Integer,java.lang.Boolean> getColVisibilities()
Returns the colVisibilities map.- Returns:
- the colVisibilities map
-
getListItems
protected java.util.List<CmsListItem> getListItems() throws org.opencms.main.CmsException
Description copied from class:A_CmsListDialog
Should generate a list with the list items to be displayed.- Specified by:
getListItems
in classA_CmsListDialog
- Returns:
- a list of
sCmsListItem
- Throws:
org.opencms.main.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 org.opencms.file.CmsProject getProject()
Returns the project to use as reference.- Returns:
- the project to use as reference
-
initWorkplaceRequestValues
protected void initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
- Overrides:
initWorkplaceRequestValues
in classA_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
- someCmsUserSettings.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 classA_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 forprefs
- the user preferences
-
setColVisibilities
protected void setColVisibilities(java.util.Map<java.lang.Integer,java.lang.Boolean> 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 classA_CmsListDialog
- Parameters:
metadata
- the list metadata- See Also:
A_CmsListDialog.setIndependentActions(org.opencms.workplace.list.CmsListMetadata)
-
-