|
|||||||
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
org.opencms.workplace.search.CmsSearchResultsList
Explorer list for the search results.
Field Summary | |
static java.lang.String |
LIST_COLUMN_SCORE
List column id constant. |
static java.lang.String |
LIST_DETAIL_EXCERPT
list item detail id constant. |
static java.lang.String |
LIST_ID
list id constant. |
static java.lang.String |
PATH_BUTTONS
Path to the list buttons. |
Fields inherited from class org.opencms.workplace.tools.CmsToolDialog |
PARAM_BASE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW |
Constructor Summary | |
CmsSearchResultsList(CmsJspActionElement jsp)
Public constructor with JSP action element. |
|
CmsSearchResultsList(javax.servlet.jsp.PageContext context,
javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res)
Public constructor with JSP variables. |
Method Summary | |
protected java.lang.String |
defaultActionHtmlStart()
Generates the dialog starting html code. |
void |
executeListMultiActions()
This method should handle every defined list multi action, by comparing with the id
of the action to execute. |
void |
executeListSingleActions()
This method should handle every defined list single action, by comparing with the id
of the action to execute. |
protected void |
fillDetails(java.lang.String detailId)
Lazy initialization for detail data. |
I_CmsListResourceCollector |
getCollector()
Returns the collector to use to display the resources. |
protected void |
initMessages()
Initializes the message object. |
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 |
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 void |
validateParamaters()
Should be overridden for parameter validation. |
Methods inherited from class org.opencms.workplace.list.A_CmsListExplorerDialog |
applyColumnVisibilities, executeListIndepActions, executeSelectPage, fillList, getColVisibilities, getListItems, getListStateForCollector, getParamShowexplorer, getProject, getResourceUtil, getResourceUtil, initWorkplaceRequestValues, isColumnVisible, setColumnVisibility, setColVisibilities, setParamShowexplorer |
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_COLUMN_SCORE
public static final java.lang.String LIST_DETAIL_EXCERPT
public static final java.lang.String LIST_ID
public static final java.lang.String PATH_BUTTONS
Constructor Detail |
public CmsSearchResultsList(CmsJspActionElement jsp)
jsp
- an initialized JSP action elementpublic CmsSearchResultsList(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
context
- the JSP page contextreq
- the JSP requestres
- the JSP responseMethod Detail |
public void executeListMultiActions()
A_CmsListDialog
A_CmsListDialog.getParamListAction()
with the id
of the action to execute.
executeListMultiActions
in class A_CmsListDialog
A_CmsListDialog.executeListMultiActions()
public void executeListSingleActions() throws java.io.IOException, javax.servlet.ServletException
A_CmsListDialog
A_CmsListDialog.getParamListAction()
with the id
of the action to execute.
executeListSingleActions
in class A_CmsListDialog
java.io.IOException
- in case of errors when including a required sub-element
javax.servlet.ServletException
- in case of errors when including a required sub-elementA_CmsListDialog.executeListSingleActions()
public I_CmsListResourceCollector getCollector()
A_CmsListExplorerDialog
getCollector
in class A_CmsListExplorerDialog
A_CmsListExplorerDialog.getCollector()
protected java.lang.String defaultActionHtmlStart()
defaultActionHtmlStart
in class A_CmsListExplorerDialog
A_CmsListDialog.defaultActionHtmlStart()
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 void initMessages()
CmsWorkplace
By default the CmsWorkplaceMessages
are initialized.
You SHOULD override this method for setting the bundles you really need,
using the
or CmsWorkplace.addMessages(CmsMessages)
method.CmsWorkplace.addMessages(String)
initMessages
in class CmsWorkplace
CmsWorkplace.initMessages()
protected void setColumns(CmsListMetadata metadata)
A_CmsListExplorerDialog
setColumns
in class A_CmsListExplorerDialog
A_CmsListDialog.setColumns(org.opencms.workplace.list.CmsListMetadata)
protected void setColumnVisibilities()
A_CmsListExplorerDialog
setColumnVisibilities
in class A_CmsListExplorerDialog
A_CmsListExplorerDialog.setColumnVisibilities()
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_CmsListExplorerDialog
A_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 void validateParamaters() throws java.lang.Exception
A_CmsListDialog
validateParamaters
in class A_CmsListDialog
java.lang.Exception
- if the parameters are not validA_CmsListDialog.validateParamaters()
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |