|
||||||
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.commons.A_CmsResourceCategoriesList
public abstract class A_CmsResourceCategoriesList
Generalized resource categories view.
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.tools.CmsToolDialog |
---|
PARAM_BASE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW |
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 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.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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String LIST_ACTION_ICON
public static final java.lang.String LIST_COLUMN_ICON
public static final java.lang.String LIST_COLUMN_NAME
public static final java.lang.String LIST_COLUMN_PATH
public static final java.lang.String LIST_COLUMN_STATE
public static final java.lang.String LIST_DETAIL_DESCRIPTION
public static final java.lang.String LIST_DETAIL_PATH
Constructor Detail |
---|
protected A_CmsResourceCategoriesList(CmsJspActionElement jsp, java.lang.String listId, CmsMessageContainer listName, boolean searchable)
jsp
- an initialized JSP action elementlistId
- the id of the listlistName
- the name of the listsearchable
- searchable flagMethod Detail |
---|
public void executeListMultiActions() throws CmsRuntimeException
A_CmsListDialog
A_CmsListDialog.getParamListAction()
with the id
of the action to execute.
executeListMultiActions
in class A_CmsListDialog
CmsRuntimeException
- to signal that an action is not supportedA_CmsListDialog.executeListMultiActions()
protected void fillDetails(java.lang.String detailId)
A_CmsListDialog
Should fill the given detail column for every list item in
Should not throw any kind of exception.CmsHtmlList.getContent()
fillDetails
in class A_CmsListDialog
detailId
- the id of the detail to initializeA_CmsListDialog.fillDetails(java.lang.String)
protected abstract java.util.List getCategories() throws CmsException
CmsException
- if something goes wrongprotected CmsCategoryService getCategoryService()
protected java.util.List getListItems() throws CmsException
A_CmsListDialog
getListItems
in class A_CmsListDialog
CmsListItem
s
CmsException
- if something goes wrongA_CmsListDialog.getListItems()
protected java.util.List getResourceCategories() throws CmsException
CmsException
- if something goes wrongprotected void setColumns(CmsListMetadata metadata)
A_CmsListDialog
This method will be just executed once, the first time the constructor is called.
setColumns
in class A_CmsListDialog
metadata
- the list metadataA_CmsListDialog.setColumns(org.opencms.workplace.list.CmsListMetadata)
protected void setIndependentActions(CmsListMetadata metadata)
A_CmsListDialog
This method will be just executed once, the first time the constructor is called.
setIndependentActions
in class A_CmsListDialog
metadata
- the list metadataA_CmsListDialog.setIndependentActions(org.opencms.workplace.list.CmsListMetadata)
protected void setMultiActions(CmsListMetadata metadata)
A_CmsListDialog
This method will be just executed once, the first time the constructor is called.
setMultiActions
in class A_CmsListDialog
metadata
- the list metadataA_CmsListDialog.setMultiActions(org.opencms.workplace.list.CmsListMetadata)
protected abstract void setStateActionCol(CmsListMetadata metadata)
metadata
- the list metadata object
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |