org.opencms.workplace.editors

接口 I_CmsEditorActionHandler

所有已知实现类:

CmsEditorActionDefault

public interface I_CmsEditorActionHandler

Provides a method for performing an individual action if the user pressed a special button in the editor.

You can define the class of your own editor action method in the OpenCms XML configuration files. The class you enter must implement this interface to perform the editor action.

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	DIRECT_EDIT_AREA_END 已过时。 use CmsDirectEditJspIncludeProvider.DIRECT_EDIT_AREA_END
static java.lang.String	DIRECT_EDIT_AREA_START 已过时。 use CmsDirectEditJspIncludeProvider.DIRECT_EDIT_AREA_END
static java.lang.String	DIRECT_EDIT_INCLUDE_FILE_URI 已过时。 not longer used (the file URI is not longer stored in the page context)
static java.lang.String	DIRECT_EDIT_INCLUDE_FILE_URI_DEFAULT 已过时。 use CmsDirectEditJspIncludeProvider.DIRECT_EDIT_INCLUDE_FILE_URI_DEFAULT
static java.lang.String	DIRECT_EDIT_INCLUDES 已过时。 use CmsDirectEditJspIncludeProvider.DIRECT_EDIT_INCLUDES
static java.lang.String	DIRECT_EDIT_MODE_DISABLED 已过时。 use CmsDirectEditPermissions.VALUE_DISABLED or better CmsDirectEditPermissions.DISABLED
static java.lang.String	DIRECT_EDIT_MODE_ENABLED 已过时。 use CmsDirectEditPermissions.VALUE_ENABLED or better CmsDirectEditPermissions.ENABLED
static java.lang.String	DIRECT_EDIT_MODE_INACTIVE 已过时。 use CmsDirectEditPermissions.VALUE_INACTIVE or better CmsDirectEditPermissions.INACTIVE
static java.lang.String	DIRECT_EDIT_OPTION_DELETE 已过时。 use CmsDirectEditButtonSelection.VALUE_DELETE
static java.lang.String	DIRECT_EDIT_OPTION_EDIT 已过时。 use CmsDirectEditButtonSelection.VALUE_EDIT or better CmsDirectEditButtonSelection.EDIT
static java.lang.String	DIRECT_EDIT_OPTION_NEW 已过时。 use CmsDirectEditButtonSelection.VALUE_NEW
static java.lang.String	DIRECT_EDIT_PARAM_BUTTONSTYLE 已过时。 use CmsDirectEditJspIncludeProvider.DIRECT_EDIT_PARAM_BUTTONSTYLE
static java.lang.String	DIRECT_EDIT_PARAM_ELEMENT 已过时。 use CmsDirectEditJspIncludeProvider.DIRECT_EDIT_PARAM_ELEMENT
static java.lang.String	DIRECT_EDIT_PARAM_LOCALE 已过时。 use CmsDirectEditJspIncludeProvider.DIRECT_EDIT_PARAM_LOCALE
static java.lang.String	DIRECT_EDIT_PARAM_NEWLINK 已过时。 use CmsDirectEditJspIncludeProvider.DIRECT_EDIT_PARAM_NEWLINK
static java.lang.String	DIRECT_EDIT_PARAM_OPTIONS 已过时。 use CmsDirectEditJspIncludeProvider.DIRECT_EDIT_PARAM_OPTIONS
static java.lang.String	DIRECT_EDIT_PARAM_TARGET 已过时。 use CmsDirectEditJspIncludeProvider.DIRECT_EDIT_PARAM_TARGET

方法概要

方法

限定符和类型	方法和说明
void	editorAction(CmsEditor editor, CmsJspActionElement jsp) Performs an action which is configurable in the implementation of the interface, e.g. save, exit, publish.
java.lang.String	getButtonName() Returns the key name of the button displayed in the editor.
java.lang.String	getButtonUrl(CmsJspActionElement jsp, java.lang.String resourceName) Returns the URL of the button displayed in the editor.
boolean	isButtonActive(CmsJspActionElement jsp, java.lang.String resourceName) Returns true if the customized button should be active, otherwise false.

字段详细资料

DIRECT_EDIT_AREA_END

@Deprecated
static final java.lang.String DIRECT_EDIT_AREA_END

已过时。 use CmsDirectEditJspIncludeProvider.DIRECT_EDIT_AREA_END

Prefix for direct edit end elements, used on JPS pages that supply the direct edit html.

另请参阅:

常量字段值

DIRECT_EDIT_AREA_START

@Deprecated
static final java.lang.String DIRECT_EDIT_AREA_START

已过时。 use CmsDirectEditJspIncludeProvider.DIRECT_EDIT_AREA_END

Prefix for direct edit start elements, used on JPS pages that supply the direct edit html.

另请参阅:

常量字段值

DIRECT_EDIT_INCLUDE_FILE_URI

@Deprecated
static final java.lang.String DIRECT_EDIT_INCLUDE_FILE_URI

已过时。 not longer used (the file URI is not longer stored in the page context)

Key to identify the direct edit configuration file.

另请参阅:

常量字段值

DIRECT_EDIT_INCLUDE_FILE_URI_DEFAULT

@Deprecated
static final java.lang.String DIRECT_EDIT_INCLUDE_FILE_URI_DEFAULT

已过时。 use CmsDirectEditJspIncludeProvider.DIRECT_EDIT_INCLUDE_FILE_URI_DEFAULT

Default direct edit include file URI.

另请参阅:

常量字段值

DIRECT_EDIT_INCLUDES

@Deprecated
static final java.lang.String DIRECT_EDIT_INCLUDES

已过时。 use CmsDirectEditJspIncludeProvider.DIRECT_EDIT_INCLUDES

Element name for direct edit includes.

另请参阅:

常量字段值

DIRECT_EDIT_MODE_DISABLED

@Deprecated
static final java.lang.String DIRECT_EDIT_MODE_DISABLED

已过时。 use CmsDirectEditPermissions.VALUE_DISABLED or better CmsDirectEditPermissions.DISABLED

Constant for: direct edit mode disabled.

另请参阅:

常量字段值

DIRECT_EDIT_MODE_ENABLED

@Deprecated
static final java.lang.String DIRECT_EDIT_MODE_ENABLED

已过时。 use CmsDirectEditPermissions.VALUE_ENABLED or better CmsDirectEditPermissions.ENABLED

Constant for: direct edit mode enabled.

另请参阅:

常量字段值

DIRECT_EDIT_MODE_INACTIVE

@Deprecated
static final java.lang.String DIRECT_EDIT_MODE_INACTIVE

已过时。 use CmsDirectEditPermissions.VALUE_INACTIVE or better CmsDirectEditPermissions.INACTIVE

Constant for: direct edit mode inactive.

另请参阅:

常量字段值

DIRECT_EDIT_OPTION_DELETE

@Deprecated
static final java.lang.String DIRECT_EDIT_OPTION_DELETE

已过时。 use CmsDirectEditButtonSelection.VALUE_DELETE

Option value that indicates the "delete" button should be displayed.

另请参阅:

常量字段值

DIRECT_EDIT_OPTION_EDIT

@Deprecated
static final java.lang.String DIRECT_EDIT_OPTION_EDIT

已过时。 use CmsDirectEditButtonSelection.VALUE_EDIT or better CmsDirectEditButtonSelection.EDIT

Option value that indicates the "edit" button should be displayed.

另请参阅:

常量字段值

DIRECT_EDIT_OPTION_NEW

@Deprecated
static final java.lang.String DIRECT_EDIT_OPTION_NEW

已过时。 use CmsDirectEditButtonSelection.VALUE_NEW

Option value that indicates the "new" button should be displayed.

另请参阅:

常量字段值

DIRECT_EDIT_PARAM_BUTTONSTYLE

@Deprecated
static final java.lang.String DIRECT_EDIT_PARAM_BUTTONSTYLE

已过时。 use CmsDirectEditJspIncludeProvider.DIRECT_EDIT_PARAM_BUTTONSTYLE

Key to identify the edit button style, used on JPS pages that supply the direct edit html.

另请参阅:

常量字段值

DIRECT_EDIT_PARAM_ELEMENT

@Deprecated
static final java.lang.String DIRECT_EDIT_PARAM_ELEMENT

已过时。 use CmsDirectEditJspIncludeProvider.DIRECT_EDIT_PARAM_ELEMENT

Key to identify the edit element, used on JPS pages that supply the direct edit html.

另请参阅:

常量字段值

DIRECT_EDIT_PARAM_LOCALE

@Deprecated
static final java.lang.String DIRECT_EDIT_PARAM_LOCALE

已过时。 use CmsDirectEditJspIncludeProvider.DIRECT_EDIT_PARAM_LOCALE

Key to identify the edit language, used on JPS pages that supply the direct edit html.

另请参阅:

常量字段值

DIRECT_EDIT_PARAM_NEWLINK

@Deprecated
static final java.lang.String DIRECT_EDIT_PARAM_NEWLINK

已过时。 use CmsDirectEditJspIncludeProvider.DIRECT_EDIT_PARAM_NEWLINK

Key to identify the link to use for the "new" button (if enabled).

另请参阅:

常量字段值

DIRECT_EDIT_PARAM_OPTIONS

@Deprecated
static final java.lang.String DIRECT_EDIT_PARAM_OPTIONS

已过时。 use CmsDirectEditJspIncludeProvider.DIRECT_EDIT_PARAM_OPTIONS

Key to identify additional direct edit options, used e.g. to control which direct edit buttons are displayed

另请参阅:

常量字段值

DIRECT_EDIT_PARAM_TARGET

@Deprecated
static final java.lang.String DIRECT_EDIT_PARAM_TARGET

已过时。 use CmsDirectEditJspIncludeProvider.DIRECT_EDIT_PARAM_TARGET

Key to identify the edit target, used on JPS pages that supply the direct edit html.

另请参阅:

常量字段值

方法详细资料

editorAction

void editorAction(CmsEditor editor,
                CmsJspActionElement jsp)
                  throws java.io.IOException,
                         javax.servlet.jsp.JspException

Performs an action which is configurable in the implementation of the interface, e.g. save, exit, publish.

参数:

editor - the current editor instance

jsp - the JSP action element

抛出:

java.io.IOException - if a redirection fails

javax.servlet.jsp.JspException - if including a JSP fails

getButtonName

java.lang.String getButtonName()

Returns the key name of the button displayed in the editor.

返回:

the key name of the button

getButtonUrl

java.lang.String getButtonUrl(CmsJspActionElement jsp,
                            java.lang.String resourceName)

Returns the URL of the button displayed in the editor.

参数:

jsp - the JSP action element

resourceName - the name of the edited resource

返回:

the URL of the button

isButtonActive

boolean isButtonActive(CmsJspActionElement jsp,
                     java.lang.String resourceName)

Returns true if the customized button should be active, otherwise false.

参数:

jsp - the JSP action element

resourceName - the name of the edited resource

返回:

true if the customized button should be active, otherwise false