|
||||||
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.list.A_CmsSelectResourceList
public abstract class A_CmsSelectResourceList
A base list dialog to select a resource.
This dialog can be used as part of a wizard based dialog by forwarding to it and after the selection switching back to the wizard. Necessary request parameters have to be passed through.
Field Summary | |
---|---|
static int |
BUTTON_FINISH
Constant for the "Finish" button in the build button methods. |
static int |
BUTTON_NEXT
Constant for the "Next" button in the build button methods. |
static java.lang.String |
LIST_COLUMN_SELECT
List column id constant. |
static java.lang.String |
LIST_RACTION_SEL
List independent action id constant. |
Fields inherited from class org.opencms.workplace.tools.CmsToolDialog |
---|
PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW |
Constructor Summary | |
---|---|
protected |
A_CmsSelectResourceList(CmsJspActionElement jsp,
java.lang.String listId,
CmsMessageContainer listName)
Creates a new select resource list ordered and searchable by name. |
protected |
A_CmsSelectResourceList(CmsJspActionElement jsp,
java.lang.String listId,
CmsMessageContainer listName,
java.lang.String sortedColId,
CmsListOrderEnum sortOrder,
java.lang.String searchableColId)
Default constructor. |
Method Summary | |
---|---|
void |
actionDialog()
Override this to set additional parameters before forwarding or to change the forward target. |
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. |
java.lang.String |
dialogButtons()
Builds a default button row with a continue and cancel button. |
protected void |
dialogButtonsHtml(java.lang.StringBuffer result,
int button,
java.lang.String attribute)
Renders the HTML for a single input button of a specified type. |
void |
displayDialog()
Performs the dialog actions depending on the initialized action and displays the dialog form. |
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. |
abstract java.lang.String |
getListTitle()
Returns the title of the list to display. |
java.lang.String |
getSelectedResourceName()
Returns the resource name of the selected resource. |
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)
The following columns are visible by default: type icon, resource name, title and last modification date. |
abstract java.lang.String |
nextUrl()
Returns the url to forward the parameters after selection. |
protected void |
setColumns(CmsListMetadata metadata)
Adds the standard explorer view columns to the list. |
protected void |
setMultiActions(CmsListMetadata metadata)
Should add the multi actions to the given list metadata object. |
Methods inherited from class org.opencms.workplace.list.A_CmsListExplorerDialog |
---|
applyColumnVisibilities, defaultActionHtmlStart, executeListIndepActions, executeSelectPage, fillList, getCollector, getColVisibilities, getListItems, getListStateForCollector, getParamShowexplorer, getProject, getResourceUtil, getResourceUtil, setColumnVisibilities, setColumnVisibility, setColVisibilities, setIndependentActions, setParamShowexplorer |
Methods inherited from class org.opencms.workplace.tools.CmsToolDialog |
---|
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 int BUTTON_FINISH
public static final int BUTTON_NEXT
public static final java.lang.String LIST_COLUMN_SELECT
public static final java.lang.String LIST_RACTION_SEL
Constructor Detail |
---|
protected A_CmsSelectResourceList(CmsJspActionElement jsp, java.lang.String listId, CmsMessageContainer listName)
jsp
- an initialized JSP action elementlistId
- the id of the displayed listlistName
- the name of the listprotected A_CmsSelectResourceList(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 intoMethod Detail |
---|
public void actionDialog() throws javax.servlet.jsp.JspException, javax.servlet.ServletException, java.io.IOException
Usually you have to set the "action" parameter to another value before forwarding.
actionDialog
in class A_CmsListDialog
javax.servlet.jsp.JspException
- if dialog actions fail
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 pageA_CmsListDialog.actionDialog()
public java.lang.String dialogButtons()
Override this to have special buttons for your dialog.
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()
A_CmsListDialog
A_CmsListDialog.getParamListAction()
with the id
of the action to execute.
executeListSingleActions
in class A_CmsListDialog
A_CmsListDialog.executeListSingleActions()
public java.lang.String getSelectedResourceName()
public void displayDialog() throws javax.servlet.jsp.JspException, java.io.IOException, javax.servlet.ServletException
A_CmsListDialog
displayDialog
in class A_CmsListDialog
javax.servlet.jsp.JspException
- if dialog actions fail
java.io.IOException
- if writing to the JSP out fails, or in case of errors forwarding to the required result page
javax.servlet.ServletException
- in case of errors forwarding to the required result pageA_CmsListDialog.displayDialog()
public abstract java.lang.String getListTitle()
public abstract java.lang.String nextUrl()
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 void dialogButtonsHtml(java.lang.StringBuffer result, int button, java.lang.String attribute)
CmsDialog
dialogButtonsHtml
in class CmsDialog
result
- a string buffer where the rendered HTML gets appended tobutton
- a integer key to identify the buttonattribute
- an optional string with possible tag attributes, or nullCmsDialog.dialogButtonsHtml(java.lang.StringBuffer, int, java.lang.String)
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 initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
CmsWorkplace
initWorkplaceRequestValues
in class A_CmsListExplorerDialog
settings
- the workplace settingsrequest
- the current requestA_CmsListExplorerDialog.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)
protected boolean isColumnVisible(int colFlag)
Override this to set different column visibilities.
isColumnVisible
in class A_CmsListExplorerDialog
colFlag
- some CmsUserSettings.FILELIST_TITLE
like value
identifying the column to get the visibility flag for
A_CmsListExplorerDialog.isColumnVisible(int)
protected void setColumns(CmsListMetadata metadata)
A_CmsListExplorerDialog
setColumns
in class A_CmsListExplorerDialog
metadata
- the list metadataA_CmsListExplorerDialog.setColumns(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 |