| org.opencms.workplace.tools.CmsToolDialog
 org.opencms.workplace.CmsDialog
org.opencms.workplace.list.A_CmsListDialog
All known Subclasses: org.opencms.workplace.tools.workplace.broadcast.CmsSessionsList, org.opencms.workplace.tools.accounts.A_CmsRoleUsersList, org.opencms.workplace.tools.accounts.A_CmsUserGroupsList, org.opencms.workplace.commons.CmsUserSelectionList, org.opencms.workplace.tools.accounts.A_CmsOrgUnitUsersList, org.opencms.workplace.tools.accounts.CmsGroupDependenciesList, org.opencms.workplace.tools.accounts.CmsGroupTransferList, org.opencms.workplace.tools.projects.CmsProjectHistoryList, org.opencms.workplace.tools.searchindex.CmsSearchIndexSourceControlList, org.opencms.workplace.demos.list.CmsListDemo3, org.opencms.workplace.commons.CmsDeletedResourcesList, org.opencms.workplace.demos.list.CmsListDemo13, org.opencms.workplace.tools.accounts.CmsUserDependenciesList, org.opencms.workplace.demos.list.CmsListDemo10, org.opencms.workplace.tools.projects.CmsProjectsList, org.opencms.workplace.demos.list.CmsListDemo7, org.opencms.workplace.list.A_CmsListExplorerDialog, org.opencms.workplace.commons.A_CmsResourceCategoriesList, org.opencms.workplace.tools.searchindex.CmsSearchIndexList, org.opencms.workplace.demos.list.CmsListDemo16b, org.opencms.workplace.tools.accounts.A_CmsRolesList, org.opencms.workplace.commons.CmsHistoryList, org.opencms.workplace.demos.list.CmsListDemo4, org.opencms.workplace.commons.CmsPrincipalSelectionList, org.opencms.workplace.tools.scheduler.CmsSchedulerList, org.opencms.workplace.demos.list.CmsListDemo15b, org.opencms.workplace.comparison.CmsPropertyComparisonList, org.opencms.workplace.demos.list.CmsListDemo11, org.opencms.workplace.tools.modules.CmsModulesList, org.opencms.workplace.demos.list.CmsListDemo9a, org.opencms.workplace.tools.accounts.A_CmsOrgUnitsList, org.opencms.workplace.demos.list.CmsListDemo8, org.opencms.workplace.commons.CmsGroupSelectionList, org.opencms.workplace.tools.accounts.CmsUserTransferList, org.opencms.workplace.tools.accounts.A_CmsGroupsList, org.opencms.workplace.tools.modules.CmsExportpointsList, org.opencms.workplace.demos.list.CmsListDemo14, org.opencms.workplace.tools.publishqueue.CmsPublishQueuePersonalList, org.opencms.workplace.tools.modules.CmsModulesDependenciesList, org.opencms.workplace.tools.accounts.A_CmsUsersList, org.opencms.workplace.tools.searchindex.A_CmsEmbeddedListDialog, org.opencms.workplace.demos.list.CmsListDemo15a, org.opencms.workplace.demos.list.CmsListDemo5, org.opencms.workplace.tools.accounts.A_CmsGroupUsersList, org.opencms.workplace.list.A_CmsListResourceTypeDialog, org.opencms.workplace.comparison.CmsElementComparisonList, org.opencms.workplace.demos.list.CmsListDemo1, org.opencms.workplace.demos.list.CmsListDemo16a, org.opencms.workplace.commons.CmsOrgUnitSelectionList, org.opencms.workplace.tools.publishqueue.CmsPublishQueueList, org.opencms.workplace.demos.list.CmsListDemo2, org.opencms.workplace.demos.list.CmsListDemo6, org.opencms.workplace.demos.list.CmsListDemo12, org.opencms.workplace.tools.searchindex.CmsSearchFieldConfigurationList, org.opencms.workplace.demos.list.CmsListDemo9,
| A_CmsListDialog | | abstract public class A_CmsListDialog extends CmsDialog (Code) | | Provides a dialog with a list widget.
author:
Michael Moossen
version:
$Revision: 1.39 $
since:
6.0.0 |
| ACTION_LIST_INDEPENDENT_ACTION | | final public static int ACTION_LIST_INDEPENDENT_ACTION(Code) | | Value for the action: execute a list item independent action of the list.
|
| ACTION_LIST_MULTI_ACTION | | final public static int ACTION_LIST_MULTI_ACTION(Code) | | Value for the action: execute an multi action of the list.
|
| ACTION_LIST_SEARCH | | final public static int ACTION_LIST_SEARCH(Code) | | Value for the action: search the list.
|
| ACTION_LIST_SELECT_PAGE | | final public static int ACTION_LIST_SELECT_PAGE(Code) | | Value for the action: go to a page.
|
| ACTION_LIST_SINGLE_ACTION | | final public static int ACTION_LIST_SINGLE_ACTION(Code) | | Value for the action: execute a single action of the list.
|
| ACTION_LIST_SORT | | final public static int ACTION_LIST_SORT(Code) | | Value for the action: sort the list.
|
| ICON_ACTIVE | | final public static String ICON_ACTIVE(Code) | | Standard list button location.
|
| ICON_ADD | | final public static String ICON_ADD(Code) | | Standard list button location.
|
| ICON_DELETE | | final public static String ICON_DELETE(Code) | | Standard list button location.
|
| ICON_DETAILS_HIDE | | final public static String ICON_DETAILS_HIDE(Code) | | Standard list button location.
|
| ICON_DETAILS_SHOW | | final public static String ICON_DETAILS_SHOW(Code) | | Standard list button location.
|
| ICON_DISABLED | | final public static String ICON_DISABLED(Code) | | Standard list button location.
|
| ICON_INACTIVE | | final public static String ICON_INACTIVE(Code) | | Standard list button location.
|
| ICON_MINUS | | final public static String ICON_MINUS(Code) | | Standard list button location.
|
| ICON_MULTI_ACTIVATE | | final public static String ICON_MULTI_ACTIVATE(Code) | | Standard list button location.
|
| ICON_MULTI_ADD | | final public static String ICON_MULTI_ADD(Code) | | Standard list button location.
|
| ICON_MULTI_DEACTIVATE | | final public static String ICON_MULTI_DEACTIVATE(Code) | | Standard list button location.
|
| ICON_MULTI_DELETE | | final public static String ICON_MULTI_DELETE(Code) | | Standard list button location.
|
| ICON_MULTI_MINUS | | final public static String ICON_MULTI_MINUS(Code) | | Standard list button location.
|
| LIST_INDEPENDENT_ACTION | | final public static String LIST_INDEPENDENT_ACTION(Code) | | Request parameter value for the list action: a list item independent action has been triggered.
|
| LIST_MULTI_ACTION | | final public static String LIST_MULTI_ACTION(Code) | | Request parameter value for the list action: a multi action has been triggered.
|
| LIST_SEARCH | | final public static String LIST_SEARCH(Code) | | Request parameter value for the list action: search/filter.
|
| LIST_SELECT_PAGE | | final public static String LIST_SELECT_PAGE(Code) | | Request parameter value for the list action: select a page.
|
| LIST_SINGLE_ACTION | | final public static String LIST_SINGLE_ACTION(Code) | | Request parameter value for the list action: a single action has been triggered.
|
| LIST_SORT | | final public static String LIST_SORT(Code) | | Request parameter value for the list action: sort.
|
| PARAM_FORMNAME | | final public static String PARAM_FORMNAME(Code) | | Request parameter key for the requested page.
|
| PARAM_LIST_ACTION | | final public static String PARAM_LIST_ACTION(Code) | | Request parameter key for the list action.
|
| PARAM_PAGE | | final public static String PARAM_PAGE(Code) | | Request parameter key for the requested page.
|
| PARAM_SEARCH_FILTER | | final public static String PARAM_SEARCH_FILTER(Code) | | Request parameter key for search the filter.
|
| PARAM_SEL_ITEMS | | final public static String PARAM_SEL_ITEMS(Code) | | Request parameter key for the selected item(s).
|
| PARAM_SORT_COL | | final public static String PARAM_SORT_COL(Code) | | Request parameter key for the column to sort the list.
|
| A_CmsListDialog | | protected A_CmsListDialog(CmsJspActionElement jsp, String listId, CmsMessageContainer listName, String sortedColId, CmsListOrderEnum sortOrder, String searchableColId)(Code) | | Public constructor.
Parameters:
jsp - an initialized JSP action element
Parameters:
listId - the id of the displayed list
Parameters:
listName - the name of the list
Parameters:
sortedColId - the a priory sorted column
Parameters:
sortOrder - the order of the sorted column
Parameters:
searchableColId - the column to search into |
| customHtmlEnd | | protected String customHtmlEnd()(Code) | | Can be overwritten to add some code after the list.
custom html code |
| customHtmlStart | | protected String customHtmlStart()(Code) | | Can be overwritten to add some code before the list.
custom html code |
| defaultActionHtml | | public String defaultActionHtml()(Code) | | Generates the dialog starting html code.
html code |
| defaultActionHtmlContent | | protected String defaultActionHtmlContent()(Code) | | Returns the html code for the default action content.
html code |
| defaultActionHtmlEnd | | protected String defaultActionHtmlEnd()(Code) | | Generates the dialog ending html code.
html code |
| defaultActionHtmlStart | | protected String defaultActionHtmlStart()(Code) | | Generates the dialog starting html code.
html code |
| displayDialog | | public void displayDialog() throws JspException, IOException, ServletException(Code) | | Performs the dialog actions depending on the initialized action and displays the dialog form.
throws:
JspException - if dialog actions fail
throws:
IOException - if writing to the JSP out fails, or in case of errors forwarding to the required result page
throws:
ServletException - in case of errors forwarding to the required result page |
| executeDefaultActions | | public void executeDefaultActions()(Code) | | This method execute the default actions for searching, sorting and paging.
|
| executeListIndepActions | | public void executeListIndepActions()(Code) | | This method should handle the default list independent actions,
by comparing
A_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();.
|
| executeSearch | | protected void executeSearch()(Code) | | Filter a list, given the action is set to LIST_SEARCH and
the filter text is set in the PARAM_SEARCH_FILTER parameter.
|
| executeSelectPage | | protected void executeSelectPage()(Code) | | 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.
|
| executeSort | | protected void executeSort()(Code) | | Sort the list, given the action is set to LIST_SORT and
the sort column is set in the PARAM_SORT_COL parameter.
|
| fillDetails | | abstract protected void fillDetails(String detailId)(Code) | | Lazy initialization for detail data.
Should fill the given detail column for every list item in
CmsHtmlList.getContent
Should not throw any kind of exception.
Parameters:
detailId - the id of the detail to initialize |
| getListId | | final public String getListId()(Code) | | Returns the Id of the list.
the list Id |
| getListObject | | public static CmsHtmlList getListObject(Class listDialog, CmsWorkplaceSettings settings)(Code) | | Returns the list object for the given list dialog, or null
if no list object has been set.
Parameters:
listDialog - the list dialog class
Parameters:
settings - the wp settings for accessing the session the list object for this list dialog, or null |
| getListState | | protected CmsListState getListState()(Code) | | Returns the current list state.
the current list state |
| getMetadata | | public static CmsListMetadata getMetadata(String listDialogName)(Code) | | Returns the list metadata object for the given dialog.
Parameters:
listDialogName - the dialog class name the list metadata object |
| getMetadata | | protected synchronized CmsListMetadata getMetadata(String listDialogName, String listId)(Code) | | Should generate the metadata definition for the list, and return the
corresponding
CmsListMetadata object.
Parameters:
listDialogName - the name of the class generating the list
Parameters:
listId - the id of the list The metadata for the given list |
| getParamFormName | | public String getParamFormName()(Code) | | Returns the form name.
the form name |
| getParamListAction | | public String getParamListAction()(Code) | | Returns the List Action.
the List Action |
| getParamPage | | public String getParamPage()(Code) | | Returns the current Page.
the current Page |
| getParamSearchFilter | | public String getParamSearchFilter()(Code) | | Returns the Search Filter.
the Search Filter |
| getParamSelItems | | public String getParamSelItems()(Code) | | Returns the selected Items.
the selected Items |
| getParamSortCol | | public String getParamSortCol()(Code) | | Returns the sorted Column.
the sorted Column |
| getSelectedItem | | public CmsListItem getSelectedItem()(Code) | | Returns the current selected item.
the current selected item |
| getSelectedItems | | public List getSelectedItems()(Code) | | Returns a list of current selected items.
a list of current selected items |
| initializeDetail | | protected void initializeDetail(String detailId)(Code) | | Lazy details initialization.
Parameters:
detailId - the id of the detail column |
| isActive | | public boolean isActive()(Code) | | Returns the activation flag.
Useful for dialogs with several lists.
Is formname parameter
is equals to ${listId}-form.
the activation flag |
| listRecovery | | protected synchronized void listRecovery(String listId)(Code) | | Recover the last list instance that is read from the request attributes.
This is required for keep the whole list in memory while you browse a page.
Parameters:
listId - the id of the expected list |
| listSave | | protected synchronized void listSave()(Code) | | Save the state of the list in the session.
|
| refreshList | | public synchronized void refreshList()(Code) | | This method re-read the rows of the list, the user should call this method after executing an action
that add or remove rows to the list.
|
| removeList | | public void removeList()(Code) | | Removes the list from the workplace settings.
Next time the list is displayed the list will be reloaded.
|
| setColumns | | abstract protected void setColumns(CmsListMetadata metadata)(Code) | | Should create the columns and add them to the given list metadata object.
This method will be just executed once, the first time the constructor is called.
Parameters:
metadata - the list metadata |
| setIndependentActions | | abstract protected void setIndependentActions(CmsListMetadata metadata)(Code) | | Should add the independent actions to the given list metadata object.
This method will be just executed once, the first time the constructor is called.
Parameters:
metadata - the list metadata |
| setList | | public void setList(CmsHtmlList list)(Code) | | Sets the list.
Parameters:
list - the list to set |
| setListObject | | public void setListObject(Class listDialog, CmsHtmlList listObject)(Code) | | Stores the given object as "list object" for the given list dialog in the current users session.
Parameters:
listDialog - the list dialog class
Parameters:
listObject - the list to store |
| setMultiActions | | abstract protected void setMultiActions(CmsListMetadata metadata)(Code) | | Should add the multi actions to the given list metadata object.
This method will be just executed once, the first time the constructor is called.
Parameters:
metadata - the list metadata |
| setParamFormName | | public void setParamFormName(String formName)(Code) | | Sets the form name.
Parameters:
formName - the form name to set |
| setParamListAction | | public void setParamListAction(String listAction)(Code) | | Sets the List Action.
Parameters:
listAction - the list Action to set |
| setParamPage | | public void setParamPage(String page)(Code) | | Sets the current Page.
Parameters:
page - the current Page to set |
| setParamSearchFilter | | public void setParamSearchFilter(String searchFilter)(Code) | | Sets the Search Filter.
Parameters:
searchFilter - the Search Filter to set |
| setParamSelItems | | public void setParamSelItems(String paramSelItems)(Code) | | Sets the selected Items.
Parameters:
paramSelItems - the selected Items to set |
| setParamSortCol | | public void setParamSortCol(String sortCol)(Code) | | Sets the sorted Column.
Parameters:
sortCol - the sorted Column to set |
| setSearchAction | | protected void setSearchAction(CmsListMetadata metadata, String columnId)(Code) | | Creates the default search action.
Can be overridden for more sophisticated search.
Parameters:
metadata - the metadata of the list to do searchable
Parameters:
columnId - the if of the column to search into |
| validateParamaters | | protected void validateParamaters() throws Exception(Code) | | Should be overridden for parameter validation.
throws:
Exception - if the parameters are not valid |
| Methods inherited from org.opencms.workplace.CmsDialog | public void actionCloseDialog() throws JspException(Code)(Java Doc)
protected String appendDelimiter(String attribute)(Code)(Java Doc)
public String buildAjaxResultContainer(String title)(Code)(Java Doc)
protected String buildAjaxWaitMessage()(Code)(Java Doc)
public String buildLockAdditionalOptions()(Code)(Java Doc)
public String buildLockConfirmationMessageJS()(Code)(Java Doc)
public String buildLockDialog() throws CmsException(Code)(Java Doc)
public String buildLockDialog(CmsLockFilter nonBlockingFilter, CmsLockFilter blockingFilter, int hiddenTimeout, boolean includeRelated) throws CmsException(Code)(Java Doc)
public String buildLockHeaderBox() throws CmsException(Code)(Java Doc)
protected boolean checkResourcePermissions(CmsPermissionSet required, boolean neededForFolder)(Code)(Java Doc)
protected boolean checkResourcePermissions(CmsPermissionSet required, boolean neededForFolder, CmsMessageContainer errorMessage)(Code)(Java Doc)
protected String computeCurrentFolder()(Code)(Java Doc)
public String dialog(int segment, String attributes)(Code)(Java Doc)
public String dialogBlock(int segment, String headline, boolean error)(Code)(Java Doc)
public String dialogBlockEnd()(Code)(Java Doc)
public String dialogBlockStart(String headline)(Code)(Java Doc)
public String dialogButtonRow(int segment)(Code)(Java Doc)
public String dialogButtonRowEnd()(Code)(Java Doc)
public String dialogButtonRowStart()(Code)(Java Doc)
public String dialogButtons(int[] buttons, String[] attributes)(Code)(Java Doc)
public String dialogButtonsClose()(Code)(Java Doc)
public String dialogButtonsClose(String closeAttribute)(Code)(Java Doc)
public String dialogButtonsCloseDetails(String closeAttribute, String detailsAttribute)(Code)(Java Doc)
protected void dialogButtonsHtml(StringBuffer result, int button, String attribute)(Code)(Java Doc)
public String dialogButtonsOk()(Code)(Java Doc)
public String dialogButtonsOk(String okAttribute)(Code)(Java Doc)
public String dialogButtonsOkCancel()(Code)(Java Doc)
public String dialogButtonsOkCancel(String okAttributes, String cancelAttributes)(Code)(Java Doc)
public String dialogButtonsOkCancelAdvanced(String okAttributes, String cancelAttributes, String advancedAttributes)(Code)(Java Doc)
public String dialogButtonsSetOkCancel(String setAttributes, String okAttributes, String cancelAttributes)(Code)(Java Doc)
public String dialogContent(int segment, String title)(Code)(Java Doc)
public String dialogContentEnd()(Code)(Java Doc)
public String dialogContentStart(String title)(Code)(Java Doc)
public String dialogEnd()(Code)(Java Doc)
public String dialogHead(String title)(Code)(Java Doc)
public String dialogHorizontalSpacer(int width)(Code)(Java Doc)
public String dialogLockButtons()(Code)(Java Doc)
public String dialogRow(int segment)(Code)(Java Doc)
public String dialogRowEnd()(Code)(Java Doc)
public String dialogRowStart()(Code)(Java Doc)
public String dialogScriptSubmit()(Code)(Java Doc)
public String dialogSeparator()(Code)(Java Doc)
public String dialogSpacer()(Code)(Java Doc)
public String dialogStart()(Code)(Java Doc)
public String dialogStart(String attributes)(Code)(Java Doc)
public String dialogSubheadline(String headline)(Code)(Java Doc)
public String dialogToggleStart(String headline, String id, boolean show)(Code)(Java Doc)
public String dialogWhiteBox(int segment)(Code)(Java Doc)
public String dialogWhiteBoxEnd()(Code)(Java Doc)
public String dialogWhiteBoxStart()(Code)(Java Doc)
public int getAction()(Code)(Java Doc)
protected String getAdministrationBackLink()(Code)(Java Doc)
public String getCancelAction()(Code)(Java Doc)
public String getDialogRealUri()(Code)(Java Doc)
public String getDialogUri()(Code)(Java Doc)
public String getOnlineHelpUriCustom()(Code)(Java Doc)
public String getParamAction()(Code)(Java Doc)
public String getParamCloseLink()(Code)(Java Doc)
public String getParamDialogtype()(Code)(Java Doc)
public String getParamFramename()(Code)(Java Doc)
public String getParamIsPopup()(Code)(Java Doc)
public String getParamMessage()(Code)(Java Doc)
public String getParamOriginalParams()(Code)(Java Doc)
public String getParamPreActionDone()(Code)(Java Doc)
public String getParamRedirect()(Code)(Java Doc)
public String getParamResource()(Code)(Java Doc)
public String getParamTitle()(Code)(Java Doc)
public String getState() throws CmsException(Code)(Java Doc)
public boolean hasCorrectLockstate()(Code)(Java Doc)
public boolean hasSiblings()(Code)(Java Doc)
public String htmlStart()(Code)(Java Doc)
public String htmlStart(String helpUrl)(Code)(Java Doc)
public String htmlStart(String helpUrl, String title)(Code)(Java Doc)
public String htmlStartStyle(String title, String stylesheet)(Code)(Java Doc)
public void includeErrorpage(CmsWorkplace wp, Throwable t) throws JspException(Code)(Java Doc)
public static CmsDialog initCmsDialog(PageContext context, HttpServletRequest req, HttpServletResponse res)(Code)(Java Doc)
protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings, HttpServletRequest request)(Code)(Java Doc)
public boolean isPopup()(Code)(Java Doc)
public boolean isPreEditor()(Code)(Java Doc)
public String pageHtml(int segment, String helpUrl)(Code)(Java Doc)
public String pageHtml(int segment, String helpUrl, String title)(Code)(Java Doc)
protected void setAction(int value)(Code)(Java Doc)
public void setOnlineHelpUriCustom(String uri)(Code)(Java Doc)
public void setParamAction(String value)(Code)(Java Doc)
public void setParamCloseLink(String value)(Code)(Java Doc)
public void setParamDialogtype(String value)(Code)(Java Doc)
public void setParamFramename(String value)(Code)(Java Doc)
public void setParamIsPopup(String value)(Code)(Java Doc)
public void setParamMessage(String value)(Code)(Java Doc)
public void setParamOriginalParams(String paramOriginalParams)(Code)(Java Doc)
public void setParamPreActionDone(String paramPreActionDone)(Code)(Java Doc)
public void setParamRedirect(String redirect)(Code)(Java Doc)
public void setParamResource(String value)(Code)(Java Doc)
public void setParamTitle(String value)(Code)(Java Doc)
|
|
|