org.opencms.workplace.commons
Class CmsCommentImages

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

public class CmsCommentImages
extends CmsDialog

Provides methods for the comment images dialog on image gallery folders.

The following files use this class:

• /commons/commentimages.jsp

Since:

6.1.3

Version:

$Revision: 1.9 $

Author:

Andreas Zahner

Field Summary

static int	ACTION_COMMENTIMAGES Value for the action: comment images.
static java.lang.String	DIALOG_TYPE The dialog type.
static java.lang.String	PREFIX_DESCRIPTION The input field prefix for description property fields.
static java.lang.String	PREFIX_TITLE The input field prefix for title property fields.
static int	THUMB_HEIGHT The height of the dialog thumbnails.
static int	THUMB_WIDTH The width of the dialog thumbnails.

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

CmsCommentImages(CmsJspActionElement jsp)
Public constructor with JSP action element.

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

Method Summary

void	actionCommentImages() Performs the comment images action, will be called by the JSP page.
java.lang.String	buildDialogForm() Returns the HTML for the dialog input form to comment the images.
protected java.util.List	getImages() Returns the image resources of the gallery folder which are edited in the dialog form.
protected CmsImageScaler	getImageScaler() Returns the initialized image scaler object used to generate thumbnails for the dialog form.
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 comment images operation.
protected void	writeProperty(CmsResource res, java.lang.String propName, java.lang.String propValue, CmsProperty currentProperty) Writes a property value for a resource, if the value was changed.

Methods inherited from class 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, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, isPreEditor, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamResource, 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_COMMENTIMAGES

public static final int ACTION_COMMENTIMAGES

Value for the action: comment images.

See Also:

Constant Field Values

DIALOG_TYPE

public static final java.lang.String DIALOG_TYPE

The dialog type.

See Also:

Constant Field Values

PREFIX_DESCRIPTION

public static final java.lang.String PREFIX_DESCRIPTION

The input field prefix for description property fields.

See Also:

Constant Field Values

PREFIX_TITLE

public static final java.lang.String PREFIX_TITLE

The input field prefix for title property fields.

See Also:

Constant Field Values

THUMB_HEIGHT

public static final int THUMB_HEIGHT

The height of the dialog thumbnails.

See Also:

Constant Field Values

THUMB_WIDTH

public static final int THUMB_WIDTH

The width of the dialog thumbnails.

See Also:

Constant Field Values

Constructor Detail

CmsCommentImages

public CmsCommentImages(CmsJspActionElement jsp)

Public constructor with JSP action element.

Parameters:

jsp - an initialized JSP action element

CmsCommentImages

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

actionCommentImages

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

Performs the comment images action, will be called by the JSP page.

Throws:

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

buildDialogForm

public java.lang.String buildDialogForm()

Returns the HTML for the dialog input form to comment the images.

Returns:

the HTML for the dialog input form to comment the images

getImages

protected java.util.List getImages()

Returns the image resources of the gallery folder which are edited in the dialog form.

Returns:

the images of the gallery folder which are edited in the dialog form

getImageScaler

protected CmsImageScaler getImageScaler()

Returns the initialized image scaler object used to generate thumbnails for the dialog form.

Returns:

the initialized image scaler object used to generate thumbnails for the dialog form

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 comment images operation.

Returns:

true, if the resources were successfully processed, otherwise false

Throws:

CmsException - if commenting is not successful

writeProperty

protected void writeProperty(CmsResource res,
                             java.lang.String propName,
                             java.lang.String propValue,
                             CmsProperty currentProperty)
                      throws CmsException

Writes a property value for a resource, if the value was changed.

Parameters:

res - the resource to write the property to

propName - the name of the property definition

propValue - the new value of the property

currentProperty - the old property object

Throws:

CmsException - if something goes wrong