public class CmsPropertyAdvanced extends CmsTabDialog implements I_CmsDialogHandler, I_CmsPostUploadDialogHandler
The following files use this class:
限定符和类型 | 字段和说明 |
---|---|
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_POSTUPLOADHANDLER
Configuration key for the upload handler class.
|
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.
|
ACTION_SWITCHTAB, DIALOG_SWITCHTAB, PARAM_SETPRESSED, PARAM_TAB
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
PARAM_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW
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
ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD
构造器和说明 |
---|
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.
|
限定符和类型 | 方法和说明 |
---|---|
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.
|
CmsParameterConfiguration |
getConfiguration()
Returns the parameters of this configurable class instance,
or
null if the class does not need any parameters. |
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<java.lang.String,CmsProperty> |
getPropertyMap(java.util.List<CmsProperty> 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.
|
java.lang.String |
getUploadHook(CmsObject cms,
java.lang.String uploadFolderSitePath)
Gets the upload hook URI.
|
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.
|
dialogTabContent, dialogTabContentEnd, dialogTabContentStart, dialogTabContentStart, dialogTabRow, getActiveTab, getActiveTabName, getParamSetPressed, getParamTab, htmlStart, htmlStart, paramsAsHidden, setParamSetPressed, setParamTab
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
computeUpLevelLink, dialogTitle, getAdminTool, getCurrentToolPath, getParamBase, getParamForce, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, setParamForce, setParamPath, setParamRoot, setParamStyle, useNewStyle
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
public static final int ACTION_SAVE_DEFINE
public static final int ACTION_SAVE_EDIT
public static final int ACTION_SHOW_DEFINE
public static final int ACTION_SHOW_EDIT
public static final int BUTTON_DEFINE
public static final int BUTTON_FINISH
public static final java.lang.String DIALOG_SAVE_DEFINE
public static final java.lang.String DIALOG_SAVE_EDIT
public static final java.lang.String DIALOG_SHOW_DEFAULT
public static final java.lang.String DIALOG_SHOW_DEFINE
public static final java.lang.String DIALOG_SHOW_EDIT
public static final java.lang.String DIALOG_TYPE
public static final java.lang.String MODE_WIZARD
public static final java.lang.String MODE_WIZARD_CREATEINDEX
public static final java.lang.String MODE_WIZARD_INDEXCREATED
public static final java.lang.String PANEL_RESOURCE
public static final java.lang.String PANEL_STRUCTURE
public static final java.lang.String PARAM_DIALOGMODE
public static final java.lang.String PARAM_HIDEADVANCED
public static final java.lang.String PARAM_NEWPROPERTY
public static final java.lang.String PARAM_POSTUPLOADHANDLER
public static final java.lang.String PARAM_SHOWGROUP
public static final java.lang.String PREFIX_HIDDEN
public static final java.lang.String PREFIX_RESOURCE
public static final java.lang.String PREFIX_STRUCTURE
public static final java.lang.String PREFIX_USEPROPERTY
public static final java.lang.String PREFIX_VALUE
public static final java.lang.String TAB_RESOURCE
public static final java.lang.String TAB_STRUCTURE
public static final java.lang.String URI_PROPERTY_CUSTOM_DIALOG
public static final java.lang.String URI_PROPERTY_DIALOG
public static final java.lang.String URI_PROPERTY_DIALOG_HANDLER
public CmsPropertyAdvanced()
Do not use this constructor on JSP pages.
public CmsPropertyAdvanced(CmsJspActionElement jsp)
jsp
- an initialized JSP action elementpublic CmsPropertyAdvanced(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
context
- the JSP page contextreq
- the JSP requestres
- the JSP responsepublic static java.util.Map<java.lang.String,CmsProperty> getPropertyMap(java.util.List<CmsProperty> list)
list
- a list of CmsProperty objectspublic void actionCloseDialog() throws javax.servlet.jsp.JspException
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.
actionCloseDialog
在类中 CmsDialog
javax.servlet.jsp.JspException
- if including an element failspublic void actionDefine() throws javax.servlet.jsp.JspException
javax.servlet.jsp.JspException
- if problems including sub-elements occurpublic void actionDeleteResource() throws javax.servlet.jsp.JspException
If the dialog is not in wizard mode, the resource is not deleted.
javax.servlet.jsp.JspException
- if including the error page failspublic void actionEdit(javax.servlet.http.HttpServletRequest request) throws javax.servlet.jsp.JspException
request
- the HttpServletRequestjavax.servlet.jsp.JspException
- if problems including sub-elements occurpublic void addConfigurationParameter(java.lang.String paramName, java.lang.String paramValue)
I_CmsConfigurationParameterHandler
addConfigurationParameter
在接口中 I_CmsConfigurationParameterHandler
paramName
- the name of the parameterparamValue
- the value for the parameterI_CmsConfigurationParameterHandler.addConfigurationParameter(java.lang.String, java.lang.String)
public java.lang.String buildActivePropertiesList()
public java.lang.String buildEditForm()
The values of the form are set delayed, have a look at the JavaDoc of buildSetFormValues() for a detailed description.
public java.lang.String buildSetFormValues()
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);".
public java.lang.String dialogButtonsOkCancelDefine()
public CmsParameterConfiguration getConfiguration()
I_CmsConfigurationParameterHandler
null
if the class does not need any parameters.getConfiguration
在接口中 I_CmsConfigurationParameterHandler
null
if the class does not need any parametersI_CmsConfigurationParameterHandler.getConfiguration()
public java.lang.String getDialogHandler()
I_CmsDialogHandler
Store the name of the key as a public String constant in the CmsDialogSelector class.
getDialogHandler
在接口中 I_CmsDialogHandler
I_CmsDialogHandler.getDialogHandler()
public java.lang.String getDialogUri(java.lang.String resource, CmsJspActionElement jsp)
I_CmsDialogHandler
getDialogUri
在接口中 I_CmsDialogHandler
resource
- the selected resourcejsp
- the CmsJspActionElementI_CmsDialogHandler.getDialogUri(java.lang.String, CmsJspActionElement)
public java.lang.String getParamDialogmode()
The dialogmode parameter stores the different modes of the property dialog, e.g. for displaying other buttons in the new resource wizard.
public java.lang.String getParamIndexPageType()
public java.lang.String getParamNewproperty()
The new property parameter stores the name of the new defined property.
public java.lang.String getParamUsetempfileproject()
The usetempfileproject parameter stores if the file resides in the temp file project.
public java.util.List getTabParameterOrder()
CmsTabDialog
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.
getTabParameterOrder
在类中 CmsTabDialog
CmsTabDialog.getTabParameterOrder()
public java.util.List getTabs()
CmsTabDialog
getTabs
在类中 CmsTabDialog
CmsTabDialog.getTabs()
public java.lang.String getUploadHook(CmsObject cms, java.lang.String uploadFolderSitePath)
I_CmsPostUploadDialogHandler
getUploadHook
在接口中 I_CmsPostUploadDialogHandler
cms
- the current CMS contextuploadFolderSitePath
- the upload target folderI_CmsPostUploadDialogHandler.getUploadHook(org.opencms.file.CmsObject, java.lang.String)
public void initConfiguration()
I_CmsConfigurationParameterHandler
public void setParamDialogmode(java.lang.String value)
value
- the value to setpublic void setParamIndexPageType(java.lang.String paramIndexPageType)
paramIndexPageType
- the paramIndexPageType to setpublic void setParamNewproperty(java.lang.String value)
value
- the value to setpublic void setParamUsetempfileproject(java.lang.String value)
value
- the value to setprotected void dialogButtonsHtml(java.lang.StringBuffer result, int button, java.lang.String attribute)
CmsDialog
dialogButtonsHtml
在类中 CmsDialog
result
- a string buffer where the rendered HTML gets appended tobutton
- a integer key to identify the buttonattribute
- an optional string with possible tag attributes, or nullCmsDialog.dialogButtonsHtml(java.lang.StringBuffer, int, java.lang.String)
protected java.util.Map getActiveProperties()
protected CmsExplorerTypeSettings getSettingsForType(java.lang.String resTypeName)
resTypeName
- the resource type nameprotected void initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
CmsWorkplace
initWorkplaceRequestValues
在类中 CmsDialog
settings
- the workplace settingsrequest
- the current requestCmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)
protected boolean isEditable()