org.opencms.workplace.commons
Class CmsPropertyAdvanced

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

All Implemented Interfaces:

I_CmsConfigurationParameterHandler, I_CmsDialogHandler

Direct Known Subclasses:

CmsPropertyCustom

public class CmsPropertyAdvanced
extends CmsTabDialog
implements I_CmsDialogHandler

Provides methods for the properties dialog.

The following files use this class:

• /commons/property_advanced.jsp

Since:

6.0.0

Version:

$Revision: 1.39 $

Author:

Andreas Zahner

Field Summary

static int	ACTION_SAVE_DEFINE Value for the action: save defined property.
static int	ACTION_SAVE_EDIT Value for the action: save edited properties.
static int	ACTION_SHOW_DEFINE Value for the action: show define property form.
static int	ACTION_SHOW_EDIT Value for the action: show edit properties form.
static int	BUTTON_DEFINE Constant for the "Define" button in the build button method.
static int	BUTTON_FINISH Constant for the "Finish" button in the build button method.
static java.lang.String	DIALOG_SAVE_DEFINE Request parameter value for the action: save defined property.
static java.lang.String	DIALOG_SAVE_EDIT Request parameter value for the action: save edited properties.
static java.lang.String	DIALOG_SHOW_DEFAULT Request parameter value for the action: show information form.
static java.lang.String	DIALOG_SHOW_DEFINE Request parameter value for the action: show define property form.
static java.lang.String	DIALOG_SHOW_EDIT Request parameter value for the action: show edit properties form.
static java.lang.String	DIALOG_TYPE The dialog type.
static java.lang.String	MODE_WIZARD Value for the dialog mode: new resource wizard.
static java.lang.String	MODE_WIZARD_CREATEINDEX Value for the dialog mode: new resource wizard with creation of index page for new folder.
static java.lang.String	MODE_WIZARD_INDEXCREATED Value for the dialog mode: new resource wizard with index page created in new folder.
static java.lang.String	PANEL_RESOURCE Key name for the resource panel.
static java.lang.String	PANEL_STRUCTURE Key name for the structure panel.
static java.lang.String	PARAM_DIALOGMODE Request parameter name for the new property definition.
static java.lang.String	PARAM_HIDEADVANCED Configuration key for the dialog handler flag.
static java.lang.String	PARAM_NEWPROPERTY Request parameter name for the new property definition.
static java.lang.String	PARAM_SHOWGROUP Configuration key for the group name.
static java.lang.String	PREFIX_HIDDEN Prefix for the hidden fields.
static java.lang.String	PREFIX_RESOURCE Prefix for the hidden resource value.
static java.lang.String	PREFIX_STRUCTURE Prefix for the hidden structure value.
static java.lang.String	PREFIX_USEPROPERTY Prefix for the use property checkboxes.
static java.lang.String	PREFIX_VALUE Prefix for the input values.
static java.lang.String	TAB_RESOURCE Name for the shared (resource) property tab.
static java.lang.String	TAB_STRUCTURE Name for the individual (structure) property tab.
static java.lang.String	URI_PROPERTY_CUSTOM_DIALOG The URI to the customized property dialog.
static java.lang.String	URI_PROPERTY_DIALOG The URI to the standard property dialog.
static java.lang.String	URI_PROPERTY_DIALOG_HANDLER The URI to the 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, 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

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Constructor Summary

CmsPropertyAdvanced()
Default constructor needed for dialog handler implementation.

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

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

Method Summary

void	actionCloseDialog() Used to close the current JSP dialog.
void	actionDefine() Performs the define property action, will be called by the JSP page.
void	actionDeleteResource() Deletes the current resource if the dialog is in wizard mode.
void	actionEdit(javax.servlet.http.HttpServletRequest request) Performs the edit properties action, will be called by the JSP page.
void	addConfigurationParameter(java.lang.String paramName, java.lang.String paramValue) Adds a configuration parameter to this parameter configurable class instance.
java.lang.String	buildActivePropertiesList() Creates the HTML String for the active properties overview of the current resource.
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.
protected void	dialogButtonsHtml(java.lang.StringBuffer result, int button, java.lang.String attribute) Renders the HTML for a single input button of a specified type.
java.lang.String	dialogButtonsOkCancelDefine() Builds a button row with an "Ok", a "Cancel" and a "Define" button.
protected java.util.Map	getActiveProperties() Returns a map with CmsProperty object values keyed by property keys.
java.util.Map	getConfiguration() Returns the configuration of this parameter configurable class instance, or null if the class does not need to be configured.
java.lang.String	getDialogHandler() Returns the name of the handler which is used as key for the OpenCms runtime properties.
java.lang.String	getDialogUri(java.lang.String resource, CmsJspActionElement jsp) Returns the dialog URI in the OpenCms VFS to the dialog selector class.
java.lang.String	getParamDialogmode() Returns the value of the dialogmode parameter, or null if this parameter was not provided.
java.lang.String	getParamIndexPageType() Returns the paramIndexPageType.
java.lang.String	getParamNewproperty() Returns the value of the new property parameter, or null if this parameter was not provided.
java.lang.String	getParamUsetempfileproject() Returns the value of the usetempfileproject parameter, or null if this parameter was not provided.
static java.util.Map	getPropertyMap(java.util.List list) Transforms a list of CmsProperty objects with structure and resource values into a map with CmsProperty object values keyed by property keys.
protected CmsExplorerTypeSettings	getSettingsForType(java.lang.String resTypeName) Returns the explorer type settings of the resource type, considering eventual references to another type.
java.util.List	getTabParameterOrder() Returns the order of the parameter prefixes for each tab.
java.util.List	getTabs() Returns a list with localized Strings representing the names of the tabs.
void	initConfiguration() Initializes a configuration after all parameters have been added.
protected void	initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request) Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
protected boolean	isEditable() Returns whether the properties are editable or not depending on the lock state of the resource and the current project.
void	setParamDialogmode(java.lang.String value) Sets the value of the dialogmode parameter.
void	setParamIndexPageType(java.lang.String paramIndexPageType) Sets the paramIndexPageType.
void	setParamNewproperty(java.lang.String value) Sets the value of the new property parameter.
void	setParamUsetempfileproject(java.lang.String value) Sets the value of the usetempfileproject parameter.

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

public static final int ACTION_SAVE_DEFINE

Value for the action: save defined property.

See Also:

Constant Field Values

ACTION_SAVE_EDIT

public static final int ACTION_SAVE_EDIT

Value for the action: save edited properties.

See Also:

Constant Field Values

ACTION_SHOW_DEFINE

public static final int ACTION_SHOW_DEFINE

Value for the action: show define property form.

See Also:

Constant Field Values

ACTION_SHOW_EDIT

public static final int ACTION_SHOW_EDIT

Value for the action: show edit properties form.

See Also:

Constant Field Values

BUTTON_DEFINE

public static final int BUTTON_DEFINE

Constant for the "Define" button in the build button method.

See Also:

Constant Field Values

BUTTON_FINISH

public static final int BUTTON_FINISH

Constant for the "Finish" button in the build button method.

See Also:

Constant Field Values

DIALOG_SAVE_DEFINE

public static final java.lang.String DIALOG_SAVE_DEFINE

Request parameter value for the action: save defined property.

See Also:

Constant Field Values

DIALOG_SAVE_EDIT

public static final java.lang.String DIALOG_SAVE_EDIT

Request parameter value for the action: save edited properties.

See Also:

Constant Field Values

DIALOG_SHOW_DEFAULT

public static final java.lang.String DIALOG_SHOW_DEFAULT

Request parameter value for the action: show information form.

See Also:

Constant Field Values

DIALOG_SHOW_DEFINE

public static final java.lang.String DIALOG_SHOW_DEFINE

Request parameter value for the action: show define property form.

See Also:

Constant Field Values

DIALOG_SHOW_EDIT

public static final java.lang.String DIALOG_SHOW_EDIT

Request parameter value for the action: show edit properties form.

See Also:

Constant Field Values

DIALOG_TYPE

public static final java.lang.String DIALOG_TYPE

The dialog type.

See Also:

Constant Field Values

MODE_WIZARD

public static final java.lang.String MODE_WIZARD

Value for the dialog mode: new resource wizard.

See Also:

Constant Field Values

MODE_WIZARD_CREATEINDEX

public static final java.lang.String MODE_WIZARD_CREATEINDEX

Value for the dialog mode: new resource wizard with creation of index page for new folder.

See Also:

Constant Field Values

MODE_WIZARD_INDEXCREATED

public static final java.lang.String MODE_WIZARD_INDEXCREATED

Value for the dialog mode: new resource wizard with index page created in new folder.

See Also:

Constant Field Values

PANEL_RESOURCE

public static final java.lang.String PANEL_RESOURCE

Key name for the resource panel.

See Also:

Constant Field Values

PANEL_STRUCTURE

public static final java.lang.String PANEL_STRUCTURE

Key name for the structure panel.

See Also:

Constant Field Values

PARAM_DIALOGMODE

public static final java.lang.String PARAM_DIALOGMODE

Request parameter name for the new property definition.

See Also:

Constant Field Values

PARAM_HIDEADVANCED

public static final java.lang.String PARAM_HIDEADVANCED

Configuration key for the dialog handler flag.

See Also:

Constant Field Values

PARAM_NEWPROPERTY

public static final java.lang.String PARAM_NEWPROPERTY

Request parameter name for the new property definition.

See Also:

Constant Field Values

PARAM_SHOWGROUP

public static final java.lang.String PARAM_SHOWGROUP

Configuration key for the group name.

See Also:

Constant Field Values

PREFIX_HIDDEN

public static final java.lang.String PREFIX_HIDDEN

Prefix for the hidden fields.

See Also:

Constant Field Values

PREFIX_RESOURCE

public static final java.lang.String PREFIX_RESOURCE

Prefix for the hidden resource value.

See Also:

Constant Field Values

PREFIX_STRUCTURE

public static final java.lang.String PREFIX_STRUCTURE

Prefix for the hidden structure value.

See Also:

Constant Field Values

PREFIX_USEPROPERTY

public static final java.lang.String PREFIX_USEPROPERTY

Prefix for the use property checkboxes.

See Also:

Constant Field Values

PREFIX_VALUE

public static final java.lang.String PREFIX_VALUE

Prefix for the input values.

See Also:

Constant Field Values

TAB_RESOURCE

public static final java.lang.String TAB_RESOURCE

Name for the shared (resource) property tab.

See Also:

Constant Field Values

TAB_STRUCTURE

public static final java.lang.String TAB_STRUCTURE

Name for the individual (structure) property tab.

See Also:

Constant Field Values

URI_PROPERTY_CUSTOM_DIALOG

public static final java.lang.String URI_PROPERTY_CUSTOM_DIALOG

The URI to the customized property dialog.

See Also:

Constant Field Values

URI_PROPERTY_DIALOG

public static final java.lang.String URI_PROPERTY_DIALOG

The URI to the standard property dialog.

See Also:

Constant Field Values

URI_PROPERTY_DIALOG_HANDLER

public static final java.lang.String URI_PROPERTY_DIALOG_HANDLER

The URI to the property dialog handler.

See Also:

Constant Field Values

Constructor Detail

CmsPropertyAdvanced

public CmsPropertyAdvanced()

Default constructor needed for dialog handler implementation.

Do not use this constructor on JSP pages.

CmsPropertyAdvanced

public CmsPropertyAdvanced(CmsJspActionElement jsp)

Public constructor with JSP action element.

Parameters:

jsp - an initialized JSP action element

CmsPropertyAdvanced

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

getPropertyMap

public static java.util.Map getPropertyMap(java.util.List list)

Transforms a list of CmsProperty objects with structure and resource values into a map with CmsProperty object values keyed by property keys.

Parameters:

list - a list of CmsProperty objects

Returns:

a map with CmsPropery object values keyed by property keys

actionCloseDialog

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

Used to close the current JSP dialog.

This method overwrites the close dialog method in the super class, because in case a new folder is created, after this dialog a new xml page might be created.

It tries to include the URI stored in the workplace settings. This URI is determined by the frame name, which has to be set in the framename parameter.

Overrides:

actionCloseDialog in class CmsDialog

Throws:

javax.servlet.jsp.JspException - if including an element fails

actionDefine

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

Performs the define property action, will be called by the JSP page.

Throws:

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

actionDeleteResource

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

Deletes the current resource if the dialog is in wizard mode.

If the dialog is not in wizard mode, the resource is not deleted.

Throws:

javax.servlet.jsp.JspException - if including the error page fails

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.

Parameters:

request - the HttpServletRequest

Throws:

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

addConfigurationParameter

public void addConfigurationParameter(java.lang.String paramName,
                                      java.lang.String paramValue)

Description copied from interface: I_CmsConfigurationParameterHandler

Adds a configuration parameter to this parameter configurable class instance.

Specified by:

addConfigurationParameter in interface I_CmsConfigurationParameterHandler

Parameters:

paramName - the name of the parameter

paramValue - the value for the parameter

See Also:

I_CmsConfigurationParameterHandler.addConfigurationParameter(java.lang.String, java.lang.String)

buildActivePropertiesList

public java.lang.String buildActivePropertiesList()

Creates the HTML String for the active properties overview of the current resource.

Returns:

the HTML output String for active properties of the resource

buildEditForm

public java.lang.String buildEditForm()

Creates the HTML String for the edit properties form.

The values of the form are set delayed, have a look at the JavaDoc of buildSetFormValues() for a detailed description.

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);".

Returns:

the JavaScript to set the property form values delayed

dialogButtonsOkCancelDefine

public java.lang.String dialogButtonsOkCancelDefine()

Builds a button row with an "Ok", a "Cancel" and a "Define" button.

Returns:

the button row

getConfiguration

public java.util.Map getConfiguration()

Description copied from interface: I_CmsConfigurationParameterHandler

Returns the configuration of this parameter configurable class instance, or null if the class does not need to be configured.

All elements in the configuration are key, value String pairs, set using the I_CmsConfigurationParameterHandler.addConfigurationParameter(String, String) method during initialization of the loader.

Implementations will (should) not to return a direct reference to the internal configuration but just a copy of it, to avoid unwanted external manipulation.

Specified by:

getConfiguration in interface I_CmsConfigurationParameterHandler

Returns:

the configuration of this resource loader, or null

See Also:

I_CmsConfigurationParameterHandler.getConfiguration()

getDialogHandler

public java.lang.String getDialogHandler()

Description copied from interface: I_CmsDialogHandler

Returns the name of the handler which is used as key for the OpenCms runtime properties.

Store the name of the key as a public String constant in the CmsDialogSelector class.

Specified by:

getDialogHandler in interface I_CmsDialogHandler

Returns:

the name of the dialog handler

See Also:

I_CmsDialogHandler.getDialogHandler()

getDialogUri

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

Description copied from interface: I_CmsDialogHandler

Returns the dialog URI in the OpenCms VFS to the dialog selector class.

Specified by:

getDialogUri in interface I_CmsDialogHandler

Parameters:

resource - the selected resource

jsp - the CmsJspActionElement

Returns:

the absolute path to the property dialog

See Also:

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

getParamDialogmode

public java.lang.String getParamDialogmode()

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

The dialogmode parameter stores the different modes of the property dialog, e.g. for displaying other buttons in the new resource wizard.

Returns:

the value of the usetempfileproject parameter

getParamIndexPageType

public java.lang.String getParamIndexPageType()

Returns the paramIndexPageType.

Returns:

the paramIndexPageType

getParamNewproperty

public java.lang.String getParamNewproperty()

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

The new property parameter stores the name of the new defined property.

Returns:

the value of the new property parameter

getParamUsetempfileproject

public java.lang.String getParamUsetempfileproject()

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

The usetempfileproject parameter stores if the file resides in the temp file project.

Returns:

the value of the usetempfileproject parameter

getTabParameterOrder

public java.util.List getTabParameterOrder()

Description copied from class: CmsTabDialog

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.

Specified by:

getTabParameterOrder in class CmsTabDialog

Returns:

the ordered parameter prefix List

See Also:

CmsTabDialog.getTabParameterOrder()

getTabs

public java.util.List getTabs()

Description copied from class: CmsTabDialog

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

Specified by:

getTabs in class CmsTabDialog

Returns:

list with localized String for the tabs

See Also:

CmsTabDialog.getTabs()

initConfiguration

public void initConfiguration()

Description copied from interface: I_CmsConfigurationParameterHandler

Initializes a configuration after all parameters have been added.

Specified by:

initConfiguration in interface I_CmsConfigurationParameterHandler

See Also:

I_CmsConfigurationParameterHandler.initConfiguration()

setParamDialogmode

public void setParamDialogmode(java.lang.String value)

Sets the value of the dialogmode parameter.

Parameters:

value - the value to set

setParamIndexPageType

public void setParamIndexPageType(java.lang.String paramIndexPageType)

Sets the paramIndexPageType.

Parameters:

paramIndexPageType - the paramIndexPageType to set

setParamNewproperty

public void setParamNewproperty(java.lang.String value)

Sets the value of the new property parameter.

Parameters:

value - the value to set

setParamUsetempfileproject

public void setParamUsetempfileproject(java.lang.String value)

Sets the value of the usetempfileproject parameter.

Parameters:

value - the value to set

dialogButtonsHtml

protected void dialogButtonsHtml(java.lang.StringBuffer result,
                                 int button,
                                 java.lang.String attribute)

Description copied from class: CmsDialog

Renders the HTML for a single input button of a specified type.

Overrides:

dialogButtonsHtml in class CmsDialog

Parameters:

result - a string buffer where the rendered HTML gets appended to

button - a integer key to identify the button

attribute - an optional string with possible tag attributes, or null

See Also:

CmsDialog.dialogButtonsHtml(java.lang.StringBuffer, int, java.lang.String)

getActiveProperties

protected java.util.Map getActiveProperties()

Returns a map with CmsProperty object values keyed by property keys.

Returns:

a map with CmsProperty object values

getSettingsForType

protected CmsExplorerTypeSettings getSettingsForType(java.lang.String resTypeName)

Returns the explorer type settings of the resource type, considering eventual references to another type.

Parameters:

resTypeName - the resource type name

Returns:

the explorer type settings of the resource type

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)

isEditable

protected boolean isEditable()

Returns whether the properties are editable or not depending on the lock state of the resource and the current project.

Returns:

true if properties are editable, otherwise false