org.opencms.workplace.editors

类 CmsEditorActionDefault

java.lang.Object

org.opencms.workplace.editors.CmsEditorActionDefault

所有已实现的接口:

I_CmsEditorActionHandler

public class CmsEditorActionDefault
extends java.lang.Object
implements I_CmsEditorActionHandler

Provides a method to perform a user defined action when editing a page.

从以下版本开始:

6.0.0

字段概要

从接口继承的字段 org.opencms.workplace.editors.I_CmsEditorActionHandler

DIRECT_EDIT_AREA_END, DIRECT_EDIT_AREA_START, DIRECT_EDIT_INCLUDE_FILE_URI, DIRECT_EDIT_INCLUDE_FILE_URI_DEFAULT, DIRECT_EDIT_INCLUDES, DIRECT_EDIT_MODE_DISABLED, DIRECT_EDIT_MODE_ENABLED, DIRECT_EDIT_MODE_INACTIVE, DIRECT_EDIT_OPTION_DELETE, DIRECT_EDIT_OPTION_EDIT, DIRECT_EDIT_OPTION_NEW, DIRECT_EDIT_PARAM_BUTTONSTYLE, DIRECT_EDIT_PARAM_ELEMENT, DIRECT_EDIT_PARAM_LOCALE, DIRECT_EDIT_PARAM_NEWLINK, DIRECT_EDIT_PARAM_OPTIONS, DIRECT_EDIT_PARAM_TARGET

构造器概要

构造器

构造器和说明
CmsEditorActionDefault() Default constructor needed for editor action handler implementation.

方法概要

方法

限定符和类型	方法和说明
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.

从类继承的方法 java.lang.Object

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

构造器详细资料

CmsEditorActionDefault

public CmsEditorActionDefault()

Default constructor needed for editor action handler implementation.

方法详细资料

editorAction

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

从接口复制的说明: I_CmsEditorActionHandler

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

指定者:

editorAction 在接口中 I_CmsEditorActionHandler

参数:

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

另请参阅:

I_CmsEditorActionHandler.editorAction(org.opencms.workplace.editors.CmsEditor, org.opencms.jsp.CmsJspActionElement)

getButtonName

public java.lang.String getButtonName()

从接口复制的说明: I_CmsEditorActionHandler

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

指定者:

getButtonName 在接口中 I_CmsEditorActionHandler

返回:

the key name of the button

另请参阅:

I_CmsEditorActionHandler.getButtonName()

getButtonUrl

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

从接口复制的说明: I_CmsEditorActionHandler

Returns the URL of the button displayed in the editor.

指定者:

getButtonUrl 在接口中 I_CmsEditorActionHandler

参数:

jsp - the JSP action element

resourceName - the name of the edited resource

返回:

the URL of the button

另请参阅:

I_CmsEditorActionHandler.getButtonUrl(CmsJspActionElement, java.lang.String)

isButtonActive

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

从接口复制的说明: I_CmsEditorActionHandler

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

指定者:

isButtonActive 在接口中 I_CmsEditorActionHandler

参数:

jsp - the JSP action element

resourceName - the name of the edited resource

返回:

true if the customized button should be active, otherwise false

另请参阅:

I_CmsEditorActionHandler.isButtonActive(CmsJspActionElement, java.lang.String)