org.opencms.workplace.commons
Class CmsTouch

java.lang.Object
  org.opencms.workplace.CmsWorkplace
      org.opencms.workplace.tools.CmsToolDialog
          org.opencms.workplace.CmsDialog
              org.opencms.workplace.CmsMultiDialog
                  org.opencms.workplace.commons.CmsTouch

public class CmsTouch
extends CmsMultiDialog

Provides methods for the touch resource(s) dialog.

The following files use this class:

• /commons/touch.jsp

Since:

6.0.0

Version:

$Revision: 1.25 $

Author:

Andreas Zahner

Field Summary

static int	ACTION_TOUCH Value for the action: touch.
static java.lang.String	DEFAULT_DATE_STRING Default value for date last modified, the release and expire date.
static java.lang.String	DIALOG_TYPE The dialog type.
static java.lang.String	PARAM_CONTENT Request parameter name for the content flag.
static java.lang.String	PARAM_NEWTIMESTAMP Request parameter name for timestamp.
static java.lang.String	PARAM_RECURSIVE Request parameter name for the recursive flag.

Fields inherited from class org.opencms.workplace.CmsMultiDialog

DELIMITER_RESOURCES, PARAM_RESOURCELIST

Fields inherited from class 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

Fields inherited from class org.opencms.workplace.tools.CmsToolDialog

PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW

Fields inherited from class 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, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, TEMP_FILE_PREFIX, 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

Constructor Summary

CmsTouch(CmsJspActionElement jsp)
Public constructor.

CmsTouch(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
Public constructor with JSP variables.

Method Summary

void	actionTouch() Performs the resource touching, will be called by the JSP page.
java.lang.String	buildCheckContent() Creates the "rewrite content" checkbox.
java.lang.String	buildCheckRecursive() Creates the "recursive" checkbox for touching subresources of folders.
java.lang.String	calendarIncludes() Deprecated. use CmsCalendarWidget.calendarIncludes(java.util.Locale), this is just here so that old JSP still work
java.lang.String	calendarInit(java.lang.String inputFieldId, java.lang.String triggerButtonId, java.lang.String align, boolean singleClick, boolean weekNumbers, boolean mondayFirst, java.lang.String dateStatusFunc, boolean showTime) Deprecated. use CmsCalendarWidget.calendarInit(org.opencms.i18n.CmsMessages, String, String, String, boolean, boolean, boolean, String, boolean), this is just here so that old JSP still work
java.lang.String	getCurrentDateTime() Returns the current date and time as String formatted in localized pattern.
java.lang.String	getParamContent() Returns the value of the content parameter, or null if this parameter was not provided.
java.lang.String	getParamNewtimestamp() Returns the value of the new timestamp parameter, or null if this parameter was not provided.
java.lang.String	getParamRecursive() Returns the value of the recursive parameter, or null if this parameter was not provided.
protected void	initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request) Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
protected boolean	performDialogOperation() Performs the resource touching.
void	setParamContent(java.lang.String value) Sets the value of the content parameter.
void	setParamNewtimestamp(java.lang.String value) Sets the value of the new timestamp parameter.
void	setParamRecursive(java.lang.String value) Sets the value of the recursive parameter.
protected void	touchSingleResource(java.lang.String resourceName, long timeStamp, boolean recursive, boolean correctDate, boolean touchContent) Performs a touch operation for a single resource.

Methods inherited from class org.opencms.workplace.CmsMultiDialog

addMultiOperationException, buildLockHeaderBox, buildResourceList, checkMultiOperationException, checkResourcePermissions, getParamResourcelist, getResourceList, getResourceListAsParam, isMultiOperation, isOperationOnFolder, setDialogTitle, setParamResource, setParamResourcelist

Methods inherited from class org.opencms.workplace.CmsDialog

actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockDialog, buildLockDialog, 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, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, isPreEditor, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamTitle

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 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, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, htmlEnd, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, isTemporaryFileName, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, switchToCurrentProject, switchToTempProject

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_TOUCH

public static final int ACTION_TOUCH

Value for the action: touch.

See Also:

Constant Field Values

DEFAULT_DATE_STRING

public static final java.lang.String DEFAULT_DATE_STRING

Default value for date last modified, the release and expire date.

See Also:

Constant Field Values

DIALOG_TYPE

public static final java.lang.String DIALOG_TYPE

The dialog type.

See Also:

Constant Field Values

PARAM_CONTENT

public static final java.lang.String PARAM_CONTENT

Request parameter name for the content flag.

See Also:

Constant Field Values

PARAM_NEWTIMESTAMP

public static final java.lang.String PARAM_NEWTIMESTAMP

Request parameter name for timestamp.

See Also:

Constant Field Values

PARAM_RECURSIVE

public static final java.lang.String PARAM_RECURSIVE

Request parameter name for the recursive flag.

See Also:

Constant Field Values

Constructor Detail

CmsTouch

public CmsTouch(CmsJspActionElement jsp)

Public constructor.

Parameters:

jsp - an initialized JSP action element

CmsTouch

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

Public constructor with JSP variables.

Parameters:

context - the JSP page context

req - the JSP request

res - the JSP response

Method Detail

actionTouch

public void actionTouch()
                 throws javax.servlet.jsp.JspException

Performs the resource touching, will be called by the JSP page.

Throws:

javax.servlet.jsp.JspException - if problems including sub-elements occur

buildCheckContent

public java.lang.String buildCheckContent()

Creates the "rewrite content" checkbox.

Returns:

the String with the checkbox input field

buildCheckRecursive

public java.lang.String buildCheckRecursive()

Creates the "recursive" checkbox for touching subresources of folders.

Returns:

the String with the checkbox input field or an empty String for folders.

calendarIncludes

public java.lang.String calendarIncludes()

Deprecated. use CmsCalendarWidget.calendarIncludes(java.util.Locale), this is just here so that old JSP still work

Creates the HTML JavaScript and stylesheet includes required by the calendar for the head of the page.

Returns:

the necessary HTML code for the js and stylesheet includes

calendarInit

public java.lang.String calendarInit(java.lang.String inputFieldId,
                                     java.lang.String triggerButtonId,
                                     java.lang.String align,
                                     boolean singleClick,
                                     boolean weekNumbers,
                                     boolean mondayFirst,
                                     java.lang.String dateStatusFunc,
                                     boolean showTime)

Deprecated. use CmsCalendarWidget.calendarInit(org.opencms.i18n.CmsMessages, String, String, String, boolean, boolean, boolean, String, boolean), this is just here so that old JSP still work

Generates the HTML to initialize the JavaScript calendar element on the end of a page.

Parameters:

inputFieldId - the ID of the input field where the date is pasted to

triggerButtonId - the ID of the button which triggers the calendar

align - initial position of the calendar popup element

singleClick - if true, a single click selects a date and closes the calendar, otherwise calendar is closed by doubleclick

weekNumbers - show the week numbers in the calendar or not

mondayFirst - show monday as first day of week

dateStatusFunc - name of the function which determines if/how a date should be disabled

showTime - true if the time selector should be shown, otherwise false

Returns:

the HTML code to initialize a calendar poup element

getCurrentDateTime

public java.lang.String getCurrentDateTime()

Returns the current date and time as String formatted in localized pattern.

Returns:

the current date and time as String formatted in localized pattern

getParamContent

public java.lang.String getParamContent()

Returns the value of the content parameter, or null if this parameter was not provided.

The content parameter on files decides if also the content is rewritten.

Returns:

the value of the content parameter

getParamNewtimestamp

public java.lang.String getParamNewtimestamp()

Returns the value of the new timestamp parameter, or null if this parameter was not provided.

The timestamp parameter stores the new timestamp as String.

Returns:

the value of the new timestamp parameter

getParamRecursive

public java.lang.String getParamRecursive()

Returns the value of the recursive parameter, or null if this parameter was not provided.

The recursive parameter on folders decides if all subresources of the folder should be touched, too.

Returns:

the value of the recursive parameter

setParamContent

public void setParamContent(java.lang.String value)

Sets the value of the content parameter.

Parameters:

value - the value to set

setParamNewtimestamp

public void setParamNewtimestamp(java.lang.String value)

Sets the value of the new timestamp parameter.

Parameters:

value - the value to set

setParamRecursive

public void setParamRecursive(java.lang.String value)

Sets the value of the recursive parameter.

Parameters:

value - the value to set

initWorkplaceRequestValues

protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings,
                                          javax.servlet.http.HttpServletRequest request)

Description copied from class: CmsWorkplace

Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.

Overrides:

initWorkplaceRequestValues in class CmsDialog

Parameters:

settings - the workplace settings

request - the current request

See Also:

CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)

performDialogOperation

protected boolean performDialogOperation()
                                  throws CmsException

Performs the resource touching.

Specified by:

performDialogOperation in class CmsMultiDialog

Returns:

true, if the resource was touched, otherwise false

Throws:

CmsException - if touching is not successful

touchSingleResource

protected void touchSingleResource(java.lang.String resourceName,
                                   long timeStamp,
                                   boolean recursive,
                                   boolean correctDate,
                                   boolean touchContent)
                            throws CmsException

Performs a touch operation for a single resource.

Parameters:

resourceName - the resource name of the resource to touch

timeStamp - the new time stamp

recursive - the flag if the touch operation is recursive

correctDate - the flag if the new time stamp is a correct date

touchContent - if the content has to be rewritten

Throws:

CmsException - if touching the resource fails