| org.opencms.workplace.CmsDialog
 org.opencms.workplace.CmsTabDialog
All known Subclasses: org.opencms.workplace.commons.CmsPropertyAdvanced, org.opencms.workplace.commons.CmsPreferences,
| CmsTabDialog | | abstract public class CmsTabDialog extends CmsDialog (Code) | | Provides methods for tab styled dialogs.
Extend this class in order to create a tab styled dialog and provide the methods
getTabs() and getTabParameterOrder() in the new dialog class which should return lists
which represent the tabs of the dialog.
This class is used for the following dialogs:
- User preferences (CmsPreferences.java)
author:
Andreas Zahner
version:
$Revision: 1.24 $
since:
6.0.0 |
| Field Summary | |
| final public static int | ACTION_SWITCHTAB
Value for the action: switch the tab. | | final public static String | DIALOG_SWITCHTAB
Request parameter value for the action: switch the tab. | | final public static String | PARAM_SETPRESSED
Name of the request parameter for the set button pressed flag. | | final public static String | PARAM_TAB
Name of the request parameter for the current tab. |
| ACTION_SWITCHTAB | | final public static int ACTION_SWITCHTAB(Code) | | Value for the action: switch the tab.
|
| DIALOG_SWITCHTAB | | final public static String DIALOG_SWITCHTAB(Code) | | Request parameter value for the action: switch the tab.
|
| PARAM_SETPRESSED | | final public static String PARAM_SETPRESSED(Code) | | Name of the request parameter for the set button pressed flag.
|
| PARAM_TAB | | final public static String PARAM_TAB(Code) | | Name of the request parameter for the current tab.
|
| CmsTabDialog | | public CmsTabDialog(CmsJspActionElement jsp)(Code) | | Public constructor.
Parameters:
jsp - an initialized JSP action element |
| dialogTabContent | | public String dialogTabContent(int segment, String title, String attributes)(Code) | | Builds the tab content area of the dialog window.
Parameters:
segment - the HTML segment (START / END)
Parameters:
title - the title String for the dialog window
Parameters:
attributes - additional attributes for the content <div> area of the tab dialog a tab content area start / end segment |
| dialogTabContentEnd | | public String dialogTabContentEnd()(Code) | | Returns the end html for the tab content area of the dialog window.
the end html for the tab content area of the dialog window |
| dialogTabContentStart | | public String dialogTabContentStart(String title)(Code) | | Returns the start html for the tab content area of the dialog window.
Parameters:
title - the title for the dialog the start html for the tab content area of the dialog window |
| dialogTabContentStart | | public String dialogTabContentStart(String title, String attributes)(Code) | | Returns the start html for the tab content area of the dialog window.
Parameters:
title - the title for the dialog
Parameters:
attributes - additional attributes for the content <div> area of the tab dialog the start html for the tab content area of the dialog window |
| dialogTabRow | | public String dialogTabRow()(Code) | | Builds the html for the tab row of the tab dialog.
the html for the tab row |
| getActiveTab | | public int getActiveTab()(Code) | | Returns the number of the currently active tab depending on the request parameter.
This method has to be called once in initWorkplaceRequestValues after filling the request parameters.
the number of the currently active tab |
| getActiveTabName | | public String getActiveTabName()(Code) | | Returns the localized name of the currently active tab.
the localized name of the currently active tab or null if no tab name was found |
| getParamSetPressed | | public String getParamSetPressed()(Code) | | Returns the value of the setpressed parameter.
the value of the setpressed parameter |
| getParamTab | | public String getParamTab()(Code) | | Returns the value of the tab parameter.
the value of the tab parameter |
| getTabParameterOrder | | abstract public List getTabParameterOrder()(Code) | | Returns the order of the parameter prefixes for each tab.
For example, all parameters stored in tab 1 have the prefix "Tab1", i.e.
the getter and setter methods must be getParamTab1MyParameterName().
To change the tab order, simply change the order in the String array
and in the generated tab list.
the ordered parameter prefix List
See Also: org.opencms.workplace.CmsTabDialog.getTabs |
| getTabs | | abstract public List getTabs()(Code) | | Returns a list with localized Strings representing the names of the tabs.
list with localized String for the tabs |
| htmlStart | | public String htmlStart()(Code) | | Builds the start html of the page, including setting of DOCTYPE and
inserting a header with the content-type.
This overloads the default method of the parent class.
the start html of the page |
| htmlStart | | public String htmlStart(String helpUrl)(Code) | | Builds the start html of the page, including setting of DOCTYPE and
inserting a header with the content-type.
This overloads the default method of the parent class.
Parameters:
helpUrl - the key for the online help to include on the page the start html of the page |
| paramsAsHidden | | public String paramsAsHidden()(Code) | | Returns all initialized parameters of the current workplace class
as hidden field tags that can be inserted in a form.
This overwrites the method in CmsWorkplace because for each tab,
only the hidden parameters of the non displayed tabs are added.
all initialized parameters of the current workplace classas hidden field tags that can be inserted in a html form |
| setParamSetPressed | | public void setParamSetPressed(String value)(Code) | | Sets the value of the setpressed parameter.
Parameters:
value - the value to set |
| setParamTab | | public void setParamTab(String value)(Code) | | Sets the value of the tab parameter.
Parameters:
value - the value to set |
| 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)
|
|
|