|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
---|---|
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. |
Field Detail |
---|
static final java.lang.String DIRECT_EDIT_AREA_END
CmsDirectEditJspIncludeProvider.DIRECT_EDIT_AREA_END
static final java.lang.String DIRECT_EDIT_AREA_START
CmsDirectEditJspIncludeProvider.DIRECT_EDIT_AREA_END
static final java.lang.String DIRECT_EDIT_INCLUDE_FILE_URI
static final java.lang.String DIRECT_EDIT_INCLUDE_FILE_URI_DEFAULT
CmsDirectEditJspIncludeProvider.DIRECT_EDIT_INCLUDE_FILE_URI_DEFAULT
static final java.lang.String DIRECT_EDIT_INCLUDES
CmsDirectEditJspIncludeProvider.DIRECT_EDIT_INCLUDES
static final java.lang.String DIRECT_EDIT_MODE_DISABLED
CmsDirectEditPermissions.VALUE_DISABLED
or better CmsDirectEditPermissions.DISABLED
static final java.lang.String DIRECT_EDIT_MODE_ENABLED
CmsDirectEditPermissions.VALUE_ENABLED
or better CmsDirectEditPermissions.ENABLED
static final java.lang.String DIRECT_EDIT_MODE_INACTIVE
CmsDirectEditPermissions.VALUE_INACTIVE
or better CmsDirectEditPermissions.INACTIVE
static final java.lang.String DIRECT_EDIT_OPTION_DELETE
CmsDirectEditButtonSelection.VALUE_DELETE
static final java.lang.String DIRECT_EDIT_OPTION_EDIT
CmsDirectEditButtonSelection.VALUE_EDIT
or better CmsDirectEditButtonSelection.EDIT
static final java.lang.String DIRECT_EDIT_OPTION_NEW
CmsDirectEditButtonSelection.VALUE_NEW
static final java.lang.String DIRECT_EDIT_PARAM_BUTTONSTYLE
CmsDirectEditJspIncludeProvider.DIRECT_EDIT_PARAM_BUTTONSTYLE
static final java.lang.String DIRECT_EDIT_PARAM_ELEMENT
CmsDirectEditJspIncludeProvider.DIRECT_EDIT_PARAM_ELEMENT
static final java.lang.String DIRECT_EDIT_PARAM_LOCALE
CmsDirectEditJspIncludeProvider.DIRECT_EDIT_PARAM_LOCALE
static final java.lang.String DIRECT_EDIT_PARAM_NEWLINK
CmsDirectEditJspIncludeProvider.DIRECT_EDIT_PARAM_NEWLINK
static final java.lang.String DIRECT_EDIT_PARAM_OPTIONS
CmsDirectEditJspIncludeProvider.DIRECT_EDIT_PARAM_OPTIONS
static final java.lang.String DIRECT_EDIT_PARAM_TARGET
CmsDirectEditJspIncludeProvider.DIRECT_EDIT_PARAM_TARGET
Method Detail |
---|
void editorAction(CmsEditor editor, CmsJspActionElement jsp) throws java.io.IOException, javax.servlet.jsp.JspException
editor
- the current editor instancejsp
- the JSP action element
java.io.IOException
- if a redirection fails
javax.servlet.jsp.JspException
- if including a JSP failsjava.lang.String getButtonName()
java.lang.String getButtonUrl(CmsJspActionElement jsp, java.lang.String resourceName)
jsp
- the JSP action elementresourceName
- the name of the edited resource
boolean isButtonActive(CmsJspActionElement jsp, java.lang.String resourceName)
jsp
- the JSP action elementresourceName
- the name of the edited resource
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |