org.opencms.workplace.tools.publishqueue

类 CmsPublishQueueHistoricalReportDialog

java.lang.Object

org.opencms.workplace.CmsWorkplace

org.opencms.workplace.tools.CmsToolDialog

org.opencms.workplace.CmsDialog

org.opencms.workplace.CmsWidgetDialog

org.opencms.workplace.tools.publishqueue.CmsPublishQueueHistoricalReportDialog

所有已实现的接口:

I_CmsWidgetDialog

public class CmsPublishQueueHistoricalReportDialog
extends CmsWidgetDialog

Provides a dialog to view a publish report selected out of the personal publish list.

从以下版本开始:

6.5.5

字段概要

字段

限定符和类型	字段和说明
protected java.lang.String	m_jobId The path to the underlying file.
static java.lang.String	PARAM_ID Request parameter name for the publish job id.

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

ACTION_ELEMENT_ADD, ACTION_ELEMENT_REMOVE, ACTION_ERROR, ACTION_SAVE, DIALOG_SAVE, EDITOR_ACTION_ELEMENT_ADD, EDITOR_ACTION_ELEMENT_REMOVE, HIDDEN_PARAM_PREFIX, m_commitErrors, m_dialogObject, m_pages, m_paramPage, m_validationErrorList, m_widgetParamValues, m_widgets

从类继承的字段 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

构造器概要

构造器

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

方法概要

方法

限定符和类型	方法和说明
void	actionCommit() Commits the edited object after pressing the "OK" button.
protected java.lang.String	createDialogHtml(java.lang.String dialog) Returns the dialog HTML for all defined widgets of the named dialog (page).
protected void	defineWidgets() Defines the list of parameters for this dialog.
protected java.lang.String[]	getPageArray() Returns the allowed pages for this dialog.
java.lang.String	getParamFilename() Returns the file path.
java.lang.String	readFileContent() Return the file content from the underlying file or an empty String.
void	setParamId(java.lang.String value) Set the job id value.
protected void	validateParamaters() Should be overridden for parameter validation.

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

actionCancel, actionToggleElement, addCommitError, addWidget, buildAddElement, buildDialogForm, buildRemoveElement, clearDialogObject, closeDialogOnCommit, commitWidgetValues, commitWidgetValues, createDialogHtml, createDialogRowHtml, createDialogRowsHtml, createWidgetBlockEnd, createWidgetBlockStart, createWidgetErrorHeader, createWidgetTableEnd, createWidgetTableStart, defaultActionHtml, defaultActionHtmlContent, defaultActionHtmlEnd, defaultActionHtmlStart, dialogBlockEnd, dialogBlockStart, dialogButtonsCustom, displayDialog, displayDialog, fillWidgetValues, getButtonStyle, getCommitErrors, getDialogObject, getDialogTitle, getHelpMessageIds, getPages, getParamElementIndex, getParamElementName, getParameterDefinition, getParameters, getParamPage, getParamValue, getParamValue, getUserAgent, getValidationErrorList, getWidget, getWidgetHtmlEnd, getWidgetIncludes, getWidgetInitCalls, getWidgetInitMethods, getWidgets, hasCommitErrors, hasValidationErrors, initWorkplaceRequestValues, paramsAsHidden, setCommitErrors, setDialogObject, setKeyPrefix, setPages, setParamElementIndex, setParamElementName, setParamPage, setValidationErrorList, widgetParamsAsHidden, widgetParamsAsHidden, writeDialog

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

actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockDialog, buildLockDialog, buildLockHeaderBox, checkResourcePermissions, checkResourcePermissions, computeCurrentFolder, dialog, dialogBlock, 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, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, 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

从接口继承的方法 org.opencms.widgets.I_CmsWidgetDialog

button, buttonBar, buttonBarHorizontalLine, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, dialogHorizontalSpacer, getLocale, getMessages, useNewStyle

字段详细资料

PARAM_ID

public static final java.lang.String PARAM_ID

Request parameter name for the publish job id.

另请参阅:

常量字段值

m_jobId

protected java.lang.String m_jobId

The path to the underlying file.

构造器详细资料

CmsPublishQueueHistoricalReportDialog

public CmsPublishQueueHistoricalReportDialog(CmsJspActionElement jsp)

Public constructor with JSP action element.

参数:

jsp - the CmsJspActionElement

CmsPublishQueueHistoricalReportDialog

public CmsPublishQueueHistoricalReportDialog(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

方法详细资料

actionCommit

public void actionCommit()

从类复制的说明: CmsWidgetDialog

Commits the edited object after pressing the "OK" button.

指定者:

actionCommit 在类中 CmsWidgetDialog

另请参阅:

CmsWidgetDialog.actionCommit()

getParamFilename

public java.lang.String getParamFilename()

Returns the file path.

返回:

the file path

readFileContent

public java.lang.String readFileContent()
                                 throws CmsException

Return the file content from the underlying file or an empty String.

返回:

file content from the underlying file or an empty String

抛出:

CmsException - if something goes wrong

setParamId

public void setParamId(java.lang.String value)

Set the job id value.

参数:

value - the job id value

createDialogHtml

protected java.lang.String createDialogHtml(java.lang.String dialog)

Returns the dialog HTML for all defined widgets of the named dialog (page).

This overwrites the method from the super class to create a layout variation for the widgets.

覆盖:

createDialogHtml 在类中 CmsWidgetDialog

参数:

dialog - the dialog (page) to get the HTML for

返回:

dialog HTML for all defined widgets of the named dialog (page)

defineWidgets

protected void defineWidgets()

从类复制的说明: CmsWidgetDialog

Defines the list of parameters for this dialog.

指定者:

defineWidgets 在类中 CmsWidgetDialog

另请参阅:

CmsWidgetDialog.defineWidgets()

getPageArray

protected java.lang.String[] getPageArray()

从类复制的说明: CmsWidgetDialog

Returns the allowed pages for this dialog.

指定者:

getPageArray 在类中 CmsWidgetDialog

返回:

the allowed pages for this dialog

另请参阅:

CmsWidgetDialog.getPageArray()

validateParamaters

protected void validateParamaters()
                           throws java.lang.Exception

从类复制的说明: CmsWidgetDialog

Should be overridden for parameter validation.

The exception is never seen by the user, so it can be just a new Exception().

覆盖:

validateParamaters 在类中 CmsWidgetDialog

抛出:

java.lang.Exception - if the parameters are not valid

另请参阅:

CmsWidgetDialog.validateParamaters()