|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||
java.lang.Objectorg.opencms.workplace.CmsWorkplace
org.opencms.workplace.tools.CmsToolDialog
org.opencms.workplace.CmsDialog
org.opencms.workplace.list.A_CmsListDialog
org.opencms.workplace.list.A_CmsListExplorerDialog
public abstract class A_CmsListExplorerDialog
Provides a list dialog for resources.
| 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.tools.CmsToolDialog |
|---|
PARAM_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW |
| 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 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 method and catches any exception. |
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 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<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.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 java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String LIST_ACTION_EDIT
public static final java.lang.String LIST_ACTION_LOCKICON
public static final java.lang.String LIST_ACTION_PROJSTATEICON
public static final java.lang.String LIST_ACTION_TYPEICON
public static final java.lang.String LIST_COLUMN_DATECREATE
public static final java.lang.String LIST_COLUMN_DATEEXP
public static final java.lang.String LIST_COLUMN_DATELASTMOD
public static final java.lang.String LIST_COLUMN_DATEREL
public static final java.lang.String LIST_COLUMN_EDIT
public static final java.lang.String LIST_COLUMN_LOCKEDBY
public static final java.lang.String LIST_COLUMN_LOCKICON
public static final java.lang.String LIST_COLUMN_NAME
public static final java.lang.String LIST_COLUMN_PERMISSIONS
public static final java.lang.String LIST_COLUMN_PROJSTATEICON
public static final java.lang.String LIST_COLUMN_ROOT_PATH
public static final java.lang.String LIST_COLUMN_SITE
public static final java.lang.String LIST_COLUMN_SIZE
public static final java.lang.String LIST_COLUMN_STATE
public static final java.lang.String LIST_COLUMN_TITLE
public static final java.lang.String LIST_COLUMN_TYPE
public static final java.lang.String LIST_COLUMN_TYPEICON
public static final java.lang.String LIST_COLUMN_USERCREATE
public static final java.lang.String LIST_COLUMN_USERLASTMOD
public static final java.lang.String LIST_DEFACTION_OPEN
public static final java.lang.String PARAM_SHOW_EXPLORER
public static final java.lang.String PATH_EXPLORER_LIST
| Constructor Detail |
|---|
protected A_CmsListExplorerDialog(CmsJspActionElement jsp,
java.lang.String listId,
CmsMessageContainer listName)
jsp - an initialized JSP action elementlistId - the id of the displayed listlistName - the name of the list
protected A_CmsListExplorerDialog(CmsJspActionElement jsp,
java.lang.String listId,
CmsMessageContainer listName,
java.lang.String sortedColId,
CmsListOrderEnum sortOrder,
java.lang.String searchableColId)
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 |
|---|
public void executeListIndepActions()
A_CmsListDialogA_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();.
executeListIndepActions in class A_CmsListDialogA_CmsListDialog.executeListIndepActions()public abstract I_CmsListResourceCollector getCollector()
public java.lang.String getParamShowexplorer()
public CmsResourceUtil getResourceUtil()
public CmsResourceUtil getResourceUtil(CmsListItem item)
item - the item representing the resource
public void setParamShowexplorer(java.lang.String showExplorer)
showExplorer - the Show explorer parameter value to setprotected void applyColumnVisibilities()
protected java.lang.String defaultActionHtmlStart()
A_CmsListDialog
defaultActionHtmlStart in class A_CmsListDialogA_CmsListDialog.defaultActionHtmlStart()protected void executeSelectPage()
A_CmsListDialogLIST_SELECT_PAGE and
the page to go to is set in the PARAM_PAGE parameter.
executeSelectPage in class A_CmsListDialogA_CmsListDialog.executeSelectPage()protected void fillList()
A_CmsListDialogA_CmsListDialog.getListItems() method and catches any exception.
fillList in class A_CmsListDialogA_CmsListDialog.fillList()protected java.util.Map<java.lang.String,java.lang.String[]> getAdditionalParametersForExplorerForward()
protected java.util.Map<java.lang.Integer,java.lang.Boolean> getColVisibilities()
protected java.util.List<CmsListItem> getListItems()
throws CmsException
A_CmsListDialog
getListItems in class A_CmsListDialogCmsListItems
CmsException - if something goes wrongA_CmsListDialog.getListItems()protected CmsListState getListStateForCollector()
protected CmsProject getProject()
protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings,
javax.servlet.http.HttpServletRequest request)
CmsWorkplace
initWorkplaceRequestValues in class A_CmsListDialogsettings - the workplace settingsrequest - the current requestCmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)protected boolean isColumnVisible(int colFlag)
The default behavior is to show the same columns as the explorer view, but this can be overwritten.
colFlag - some CmsUserSettings.FILELIST_TITLE like value
identifying the column to get the visibility flag for
protected void setColumns(CmsListMetadata metadata)
setColumns in class A_CmsListDialogmetadata - the list metadataA_CmsListDialog.setColumns(org.opencms.workplace.list.CmsListMetadata)protected void setColumnVisibilities()
protected void setColumnVisibility(int colFlag,
int prefs)
colFlag - the flag that identifies the column to set the flag forprefs - the user preferencesprotected void setColVisibilities(java.util.Map<java.lang.Integer,java.lang.Boolean> colVisibilities)
colVisibilities - the colVisibilities map to setprotected void setIndependentActions(CmsListMetadata metadata)
A_CmsListDialogThis method will be just executed once, the first time the constructor is called.
setIndependentActions in class A_CmsListDialogmetadata - the list metadataA_CmsListDialog.setIndependentActions(org.opencms.workplace.list.CmsListMetadata)
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||