|
|||||||
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_CmsListResourceTypeDialog
Super class for all dialogs needed to display a list of resource types.
Field Summary | |
static java.lang.String |
LIST_ACTION_SEL
List independent 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_SELECT
List column id constant. |
static java.lang.String |
LIST_DETAIL_DESCRIPTION
List detail description info. |
static java.lang.String |
LIST_ID
List id constant. |
static java.lang.String |
PARAM_SELECTED_TYPE
Request parameter name for the index page resource type. |
Fields inherited from class org.opencms.workplace.tools.CmsToolDialog |
PARAM_BASE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW |
Constructor Summary | |
A_CmsListResourceTypeDialog(CmsJspActionElement jsp)
Public constructor with JSP action element. |
|
A_CmsListResourceTypeDialog(CmsJspActionElement jsp,
java.lang.String listId,
CmsMessageContainer listName,
java.lang.String sortedColId,
CmsListOrderEnum sortOrder,
java.lang.String searchableColId)
Public constructor. |
|
A_CmsListResourceTypeDialog(javax.servlet.jsp.PageContext context,
javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res)
Public constructor with JSP variables. |
Method Summary | |
void |
actionDialog()
Performs the dialog actions depending on the initialized action. |
protected java.lang.String |
customHtmlBeforeList()
Returns the html code to add directly before the list inside the form element. |
protected java.lang.String |
customHtmlEnd()
Can be overwritten to add some code after the list. |
protected java.lang.String |
customHtmlStart()
Can be overwritten to add some code before the list. |
protected java.lang.String |
defaultActionHtmlContent()
Returns the html code for the default action content. |
java.lang.String |
dialogButtons()
Builds a default button row with a continue and cancel button. |
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. |
java.lang.String |
getParamSelectedType()
Returns the paramSelectedType. |
java.lang.String |
paramsAsHidden()
Returns all initialized parameters of the current workplace class as hidden field tags that can be inserted in a form. |
java.lang.String |
paramsAsHidden(java.util.Collection excludes)
Returns all initialized parameters of the current workplace class that are not in the given exclusion list as hidden field tags that can be inserted in a form. |
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. |
void |
setParamSelectedType(java.lang.String paramSelectedType)
Sets the paramSelectedType. |
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_SEL
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_SELECT
public static final java.lang.String LIST_DETAIL_DESCRIPTION
public static final java.lang.String LIST_ID
public static final java.lang.String PARAM_SELECTED_TYPE
Constructor Detail |
public A_CmsListResourceTypeDialog(CmsJspActionElement jsp)
jsp
- an initialized JSP action elementpublic A_CmsListResourceTypeDialog(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 intopublic A_CmsListResourceTypeDialog(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 actionDialog() throws javax.servlet.jsp.JspException, javax.servlet.ServletException, java.io.IOException
A_CmsListDialog
actionDialog
in class A_CmsListDialog
javax.servlet.ServletException
- in case of errors forwarding to the required result page
java.io.IOException
- in case of errors forwarding to the required result page
javax.servlet.jsp.JspException
- if dialog actions failA_CmsListDialog.actionDialog()
public java.lang.String dialogButtons()
Override this to have special buttons for your dialog.
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()
public void executeListSingleActions() throws CmsRuntimeException
A_CmsListDialog
A_CmsListDialog.getParamListAction()
with the id
of the action to execute.
executeListSingleActions
in class A_CmsListDialog
CmsRuntimeException
- to signal that an action is not supportedA_CmsListDialog.executeListSingleActions()
public java.lang.String getParamSelectedType()
public java.lang.String paramsAsHidden()
CmsWorkplace
paramsAsHidden
in class CmsWorkplace
CmsWorkplace.paramsAsHidden()
public java.lang.String paramsAsHidden(java.util.Collection excludes)
CmsWorkplace
paramsAsHidden
in class CmsWorkplace
excludes
- the parameters to exclude
CmsWorkplace.paramsAsHidden(java.util.Collection)
public void setParamSelectedType(java.lang.String paramSelectedType)
paramSelectedType
- the paramSelectedType to setprotected java.lang.String customHtmlBeforeList()
protected java.lang.String customHtmlEnd()
A_CmsListDialog
customHtmlEnd
in class A_CmsListDialog
A_CmsListDialog.customHtmlEnd()
protected java.lang.String customHtmlStart()
A_CmsListDialog
customHtmlStart
in class A_CmsListDialog
A_CmsListDialog.customHtmlStart()
protected java.lang.String defaultActionHtmlContent()
A_CmsListDialog
defaultActionHtmlContent
in class A_CmsListDialog
A_CmsListDialog.defaultActionHtmlContent()
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 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)
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |