org.opencms.workplace

类 CmsTabDialog

java.lang.Object

org.opencms.workplace.CmsWorkplace

org.opencms.workplace.tools.CmsToolDialog

org.opencms.workplace.CmsDialog

org.opencms.workplace.CmsTabDialog

直接已知子类:

CmsPreferences, CmsPropertyAdvanced

public abstract class CmsTabDialog
extends CmsDialog

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)

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
static int	ACTION_SWITCHTAB Value for the action: switch the tab.
static java.lang.String	DIALOG_SWITCHTAB Request parameter value for the action: switch the tab.
static java.lang.String	PARAM_SETPRESSED Name of the request parameter for the set button pressed flag.
static java.lang.String	PARAM_TAB Name of the request parameter for the current tab.

从类继承的字段 org.opencms.workplace.CmsDialog

ACTION_CANCEL, ACTION_CLOSEPOPUP, ACTION_CLOSEPOPUP_SAVE, ACTION_CONFIRMED, ACTION_CONTINUE, ACTION_DEFAULT, ACTION_LOCKS_CONFIRMED, ACTION_OK, ACTION_REPORT_BEGIN, ACTION_REPORT_END, ACTION_REPORT_UPDATE, ACTION_SET, ACTION_WAIT, ATTRIBUTE_THROWABLE, BUTTON_ADVANCED, BUTTON_BACK, BUTTON_CANCEL, BUTTON_CLOSE, BUTTON_CONTINUE, BUTTON_DETAILS, BUTTON_DISCARD, BUTTON_EDIT, BUTTON_OK, BUTTON_OK_NO_SUBMIT, BUTTON_SET, DIALOG_BACK, DIALOG_CANCEL, DIALOG_CONFIRMED, DIALOG_CONTINUE, DIALOG_INITIAL, DIALOG_LOCKS_CONFIRMED, DIALOG_OK, DIALOG_SET, DIALOG_WAIT, PARAM_ACTION, PARAM_CLOSELINK, PARAM_DIALOGTYPE, PARAM_ERRORSTACK, PARAM_FILE, PARAM_FRAMENAME, PARAM_ISPOPUP, PARAM_LOCK, PARAM_MESSAGE, PARAM_ORIGINALPARAMS, PARAM_PREACTIONDONE, PARAM_REDIRECT, PARAM_RESOURCE, PARAM_TARGET, PARAM_THREAD, PARAM_THREAD_HASNEXT, PARAM_TITLE, REPORT_BEGIN, REPORT_END, REPORT_UPDATE

从类继承的字段 org.opencms.workplace.tools.CmsToolDialog

PARAM_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW

从类继承的字段 org.opencms.workplace.CmsWorkplace

DEBUG, DEFAULT_LANGUAGE, DEFAULT_LOCALE, DIALOG_PATH_COMMON, FILE_DIALOG_CLOSE, FILE_DIALOG_SCREEN_CONFIRM, FILE_DIALOG_SCREEN_ERROR, FILE_DIALOG_SCREEN_ERRORPAGE, FILE_DIALOG_SCREEN_WAIT, FILE_EXPLORER_FILELIST, FILE_REPORT_OUTPUT, HTML_END, HTML_START, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PATH_DIALOGS, PATH_WORKPLACE, REQUEST_ATTRIBUTE_MULTIPART, REQUEST_ATTRIBUTE_RELOADTREE, RES_PATH_FILETYPES, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, VFS_DIR_DEFAULTBODIES, VFS_DIR_TEMPLATES, VFS_PATH_COMMONS, VFS_PATH_EDITORS, VFS_PATH_GALLERIES, VFS_PATH_LOCALES, VFS_PATH_MODULES, VFS_PATH_RESOURCES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_DIRECT_EDIT, VIEW_WORKPLACE

构造器概要

构造器

构造器和说明
CmsTabDialog(CmsJspActionElement jsp) Public constructor.
CmsTabDialog(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Public constructor with JSP variables.

方法概要

方法

限定符和类型	方法和说明
java.lang.String	dialogTabContent(int segment, java.lang.String title, java.lang.String attributes) Builds the tab content area of the dialog window.
java.lang.String	dialogTabContentEnd() Returns the end html for the tab content area of the dialog window.
java.lang.String	dialogTabContentStart(java.lang.String title) Returns the start html for the tab content area of the dialog window.
java.lang.String	dialogTabContentStart(java.lang.String title, java.lang.String attributes) Returns the start html for the tab content area of the dialog window.
java.lang.String	dialogTabRow() Builds the html for the tab row of the tab dialog.
int	getActiveTab() Returns the number of the currently active tab depending on the request parameter.
java.lang.String	getActiveTabName() Returns the localized name of the currently active tab.
java.lang.String	getParamSetPressed() Returns the value of the setpressed parameter.
java.lang.String	getParamTab() Returns the value of the tab parameter.
abstract java.util.List<java.lang.String>	getTabParameterOrder() Returns the order of the parameter prefixes for each tab.
abstract java.util.List<java.lang.String>	getTabs() Returns a list with localized Strings representing the names of the tabs.
java.lang.String	htmlStart() Builds the start html of the page, including setting of DOCTYPE and inserting a header with the content-type.
java.lang.String	htmlStart(java.lang.String helpUrl) Builds the start html of the page, including setting of DOCTYPE and inserting a header with the content-type.
java.lang.String	paramsAsHidden() Returns all initialized parameters of the current workplace class as hidden field tags that can be inserted in a form.
void	setParamSetPressed(java.lang.String value) Sets the value of the setpressed parameter.
void	setParamTab(java.lang.String value) Sets the value of the tab parameter.

从类继承的方法 org.opencms.workplace.CmsDialog

actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockDialog, buildLockDialog, buildLockHeaderBox, checkResourcePermissions, checkResourcePermissions, computeCurrentFolder, dialog, dialogBlock, dialogBlockEnd, dialogBlockStart, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, dialogButtonsHtml, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, dialogButtonsOkCancelAdvanced, dialogButtonsSetOkCancel, dialogContent, dialogContentEnd, dialogContentStart, dialogEnd, dialogHead, dialogHorizontalSpacer, dialogLockButtons, dialogRow, dialogRowEnd, dialogRowStart, dialogScriptSubmit, dialogSeparator, dialogSpacer, dialogStart, dialogStart, dialogSubheadline, dialogToggleStart, dialogWhiteBox, dialogWhiteBoxEnd, dialogWhiteBoxStart, getAction, getAdministrationBackLink, getCancelAction, getDialogRealUri, getDialogUri, getOnlineHelpUriCustom, getParamAction, getParamCloseLink, getParamDialogtype, getParamFramename, getParamIsPopup, getParamMessage, getParamOriginalParams, getParamPreActionDone, getParamRedirect, getParamResource, getParamTitle, getState, hasCorrectLockstate, hasSiblings, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, initWorkplaceRequestValues, isPopup, isPreEditor, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamResource, setParamTitle

从类继承的方法 org.opencms.workplace.tools.CmsToolDialog

computeUpLevelLink, dialogTitle, getAdminTool, getCurrentToolPath, getParamBase, getParamForce, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, setParamForce, setParamPath, setParamRoot, setParamStyle, useNewStyle

从类继承的方法 org.opencms.workplace.CmsWorkplace

addMessages, addMessages, allParamsAsHidden, allParamsAsRequest, allParamValues, bodyEnd, bodyStart, bodyStart, buildSelect, buildSelect, button, button, buttonBar, buttonBar, buttonBarHorizontalLine, buttonBarLabel, buttonBarLabel, buttonBarLine, buttonBarLineSpacer, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStartSiteRoot, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, htmlEnd, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, switchToCurrentProject, switchToTempProject

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

ACTION_SWITCHTAB

public static final int ACTION_SWITCHTAB

Value for the action: switch the tab.

另请参阅:

常量字段值

DIALOG_SWITCHTAB

public static final java.lang.String DIALOG_SWITCHTAB

Request parameter value for the action: switch the tab.

另请参阅:

常量字段值

PARAM_SETPRESSED

public static final java.lang.String PARAM_SETPRESSED

Name of the request parameter for the set button pressed flag.

另请参阅:

常量字段值

PARAM_TAB

public static final java.lang.String PARAM_TAB

Name of the request parameter for the current tab.

另请参阅:

常量字段值

构造器详细资料

CmsTabDialog

public CmsTabDialog(CmsJspActionElement jsp)

Public constructor.

参数:

jsp - an initialized JSP action element

CmsTabDialog

public CmsTabDialog(javax.servlet.jsp.PageContext context,
            javax.servlet.http.HttpServletRequest req,
            javax.servlet.http.HttpServletResponse res)

Public constructor with JSP variables.

参数:

context - the JSP page context

req - the JSP request

res - the JSP response

方法详细资料

dialogTabContent

public java.lang.String dialogTabContent(int segment,
                                java.lang.String title,
                                java.lang.String attributes)

Builds the tab content area of the dialog window.

参数:

segment - the HTML segment (START / END)

title - the title String for the dialog window

attributes - additional attributes for the content <div> area of the tab dialog

返回:

a tab content area start / end segment

dialogTabContentEnd

public java.lang.String dialogTabContentEnd()

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 java.lang.String dialogTabContentStart(java.lang.String title)

Returns the start html for the tab content area of the dialog window.

参数:

title - the title for the dialog

返回:

the start html for the tab content area of the dialog window

dialogTabContentStart

public java.lang.String dialogTabContentStart(java.lang.String title,
                                     java.lang.String attributes)

Returns the start html for the tab content area of the dialog window.

参数:

title - the title for the dialog

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 java.lang.String dialogTabRow()

Builds the html for the tab row of the tab dialog.

返回:

the html for the tab row

getActiveTab

public int getActiveTab()

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 java.lang.String getActiveTabName()

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 java.lang.String getParamSetPressed()

Returns the value of the setpressed parameter.

返回:

the value of the setpressed parameter

getParamTab

public java.lang.String getParamTab()

Returns the value of the tab parameter.

返回:

the value of the tab parameter

getTabParameterOrder

public abstract java.util.List<java.lang.String> getTabParameterOrder()

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

另请参阅:

getTabs()

getTabs

public abstract java.util.List<java.lang.String> getTabs()

Returns a list with localized Strings representing the names of the tabs.

返回:

list with localized String for the tabs

htmlStart

public java.lang.String htmlStart()

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.

覆盖:

htmlStart 在类中 CmsDialog

返回:

the start html of the page

htmlStart

public java.lang.String htmlStart(java.lang.String helpUrl)

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.

覆盖:

htmlStart 在类中 CmsDialog

参数:

helpUrl - the key for the online help to include on the page

返回:

the start html of the page

paramsAsHidden

public java.lang.String paramsAsHidden()

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.

覆盖:

paramsAsHidden 在类中 CmsWorkplace

返回:

all initialized parameters of the current workplace class as hidden field tags that can be inserted in a html form

setParamSetPressed

public void setParamSetPressed(java.lang.String value)

Sets the value of the setpressed parameter.

参数:

value - the value to set

setParamTab

public void setParamTab(java.lang.String value)

Sets the value of the tab parameter.

参数:

value - the value to set