org.opencms.frontend.templateone
Class CmsPropertyTemplateOne

java.lang.Object
  org.opencms.workplace.CmsWorkplace
      org.opencms.workplace.tools.CmsToolDialog
          org.opencms.workplace.CmsDialog
              org.opencms.workplace.CmsTabDialog
                  org.opencms.workplace.commons.CmsPropertyAdvanced
                      org.opencms.workplace.commons.CmsPropertyCustom
                          org.opencms.frontend.templateone.CmsPropertyTemplateOne

All Implemented Interfaces:

org.opencms.configuration.I_CmsConfigurationParameterHandler, org.opencms.workplace.I_CmsDialogHandler

public class CmsPropertyTemplateOne
extends org.opencms.workplace.commons.CmsPropertyCustom

This property dialog is shown specially by files using the OpenCms template one, and for any folders except system folders.

Since:

6.0.0

Field Summary

Fields inherited from class org.opencms.workplace.commons.CmsPropertyCustom

ACTION_EDIT

Fields inherited from class org.opencms.workplace.commons.CmsPropertyAdvanced

ACTION_SAVE_DEFINE, ACTION_SAVE_EDIT, ACTION_SHOW_DEFINE, ACTION_SHOW_EDIT, BUTTON_DEFINE, BUTTON_FINISH, DIALOG_SAVE_DEFINE, DIALOG_SAVE_EDIT, DIALOG_SHOW_DEFAULT, DIALOG_SHOW_DEFINE, DIALOG_SHOW_EDIT, DIALOG_TYPE, MODE_WIZARD, MODE_WIZARD_CREATEINDEX, MODE_WIZARD_INDEXCREATED, PANEL_RESOURCE, PANEL_STRUCTURE, PARAM_DIALOGMODE, PARAM_HIDEADVANCED, PARAM_NEWPROPERTY, PARAM_SHOWGROUP, PREFIX_HIDDEN, PREFIX_RESOURCE, PREFIX_STRUCTURE, PREFIX_USEPROPERTY, PREFIX_VALUE, TAB_RESOURCE, TAB_STRUCTURE, URI_PROPERTY_CUSTOM_DIALOG, URI_PROPERTY_DIALOG, URI_PROPERTY_DIALOG_HANDLER

Fields inherited from class org.opencms.workplace.CmsTabDialog

ACTION_SWITCHTAB, DIALOG_SWITCHTAB, PARAM_SETPRESSED, PARAM_TAB

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, 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

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Constructor Summary

CmsPropertyTemplateOne()
Default constructor needed for dialog handler implementation.

CmsPropertyTemplateOne(org.opencms.jsp.CmsJspActionElement jsp)
Public constructor with JSP action element.

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

Method Summary

void	actionEdit(javax.servlet.http.HttpServletRequest request) Performs the edit properties action, will be called by the JSP page.
java.lang.String	buildCheckBox(java.lang.String propertyName, java.lang.String propertyValue, java.lang.String propertyText) Build the html for a property checkbox.
java.lang.String	buildEditForm() Creates the HTML String for the edit properties form.
java.lang.String	buildSetFormValues() Builds the JavaScript to set the property form values delayed.
java.lang.String	getDefault(java.lang.String propertydef) Returns the property value by searching all parent folders.
java.lang.String	getDialogHandler()
java.lang.String	getDialogUri(java.lang.String resource, org.opencms.jsp.CmsJspActionElement jsp)
protected boolean	performEditOperation(javax.servlet.http.HttpServletRequest request) Performs the editing of the resources properties.

Methods inherited from class org.opencms.workplace.commons.CmsPropertyCustom

buildNavigationProperties, buildPropertyEntry, buildTableRowEnd, buildTableRowStart, buildTextInput, dialogButtonsOkCancelAdvanced, getExplorerTypeSettings, initExplorerTypeSettings, initWorkplaceRequestValues, isHideButtonAdvanced, setExplorerTypeSettings, setShowNavigation, showNavigation, writeProperty

Methods inherited from class org.opencms.workplace.commons.CmsPropertyAdvanced

actionCloseDialog, actionDefine, actionDeleteResource, addConfigurationParameter, buildActivePropertiesList, dialogButtonsHtml, dialogButtonsOkCancelDefine, getActiveProperties, getConfiguration, getParamDialogmode, getParamIndexPageType, getParamNewproperty, getParamUsetempfileproject, getPropertyMap, getSettingsForType, getTabParameterOrder, getTabs, initConfiguration, isEditable, setParamDialogmode, setParamIndexPageType, setParamNewproperty, setParamUsetempfileproject

Methods inherited from class org.opencms.workplace.CmsTabDialog

dialogTabContent, dialogTabContentEnd, dialogTabContentStart, dialogTabContentStart, dialogTabRow, getActiveTab, getActiveTabName, getParamSetPressed, getParamTab, htmlStart, htmlStart, paramsAsHidden, setParamSetPressed, setParamTab

Methods inherited from class org.opencms.workplace.CmsDialog

appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockDialog, buildLockDialog, buildLockHeaderBox, checkResourcePermissions, checkResourcePermissions, computeCurrentFolder, dialog, dialogBlock, dialogBlockEnd, dialogBlockStart, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, 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, 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, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, switchToCurrentProject, switchToTempProject

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsPropertyTemplateOne

public CmsPropertyTemplateOne()

Default constructor needed for dialog handler implementation.

Do not use this constructor on JSP pages.

CmsPropertyTemplateOne

public CmsPropertyTemplateOne(org.opencms.jsp.CmsJspActionElement jsp)

Public constructor with JSP action element.

Parameters:

jsp - an initialized JSP action element

CmsPropertyTemplateOne

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

actionEdit

public void actionEdit(javax.servlet.http.HttpServletRequest request)
                throws javax.servlet.jsp.JspException

Performs the edit properties action, will be called by the JSP page.

Overrides:

actionEdit in class org.opencms.workplace.commons.CmsPropertyCustom

Parameters:

request - the HttpServletRequest

Throws:

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

buildCheckBox

public java.lang.String buildCheckBox(java.lang.String propertyName,
                                      java.lang.String propertyValue,
                                      java.lang.String propertyText)

Build the html for a property checkbox.

Parameters:

propertyName - the property name

propertyValue - the property value

propertyText - the property text

Returns:

the html for a property checkbox

buildEditForm

public java.lang.String buildEditForm()

Creates the HTML String for the edit properties form.

Overrides:

buildEditForm in class org.opencms.workplace.commons.CmsPropertyCustom

Returns:

the HTML output String for the edit properties form

buildSetFormValues

public java.lang.String buildSetFormValues()

Builds the JavaScript to set the property form values delayed.

The values of the properties are not inserted directly in the <input> tag, because there is a display issue when the property values are very long. This method creates JavaScript to set the property input field values delayed. On the JSP, the code which is created from this method has to be executed delayed after the creation of the html form, e.g. in the <body> tag with the attribute onload="window.setTimeout('doSet()',50);".

Overrides:

buildSetFormValues in class org.opencms.workplace.commons.CmsPropertyCustom

Returns:

the JavaScript to set the property form values delayed

getDefault

public java.lang.String getDefault(java.lang.String propertydef)

Returns the property value by searching all parent folders.

Parameters:

propertydef - the property definition

Returns:

the property value by searching all parent folders

getDialogHandler

public java.lang.String getDialogHandler()

Specified by:

getDialogHandler in interface org.opencms.workplace.I_CmsDialogHandler

Overrides:

getDialogHandler in class org.opencms.workplace.commons.CmsPropertyAdvanced

See Also:

I_CmsDialogHandler.getDialogHandler()

getDialogUri

public java.lang.String getDialogUri(java.lang.String resource,
                                     org.opencms.jsp.CmsJspActionElement jsp)

Specified by:

getDialogUri in interface org.opencms.workplace.I_CmsDialogHandler

Overrides:

getDialogUri in class org.opencms.workplace.commons.CmsPropertyAdvanced

See Also:

I_CmsDialogHandler.getDialogUri(java.lang.String, CmsJspActionElement)

performEditOperation

protected boolean performEditOperation(javax.servlet.http.HttpServletRequest request)
                                throws org.opencms.main.CmsException

Performs the editing of the resources properties.

Overrides:

performEditOperation in class org.opencms.workplace.commons.CmsPropertyCustom

Parameters:

request - the HttpServletRequest

Returns:

true, if the properties were successfully changed, otherwise false

Throws:

org.opencms.main.CmsException - if editing is not successful