|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Provides the methods to generate the "direct edit" HTML fragments that are inserted in the generated pages in offline mode.
In case you want to implement this, it's a good idea to extend from A_CmsDirectEditProvider
or CmsDirectEditDefaultProvider
as these already contain the required low level logic.
The default direct edit provider used can be configured in opencms-workplace.xml
in the
<directeditprovider class="..." />
node. The standard provider is the
CmsDirectEditDefaultProvider
.
CmsDirectEditDefaultProvider
,
CmsDirectEditTextButtonProvider
,
CmsDirectEditJspIncludeProvider
,
CmsJspTagEditable
Field Summary | |
static java.lang.String |
ATTRIBUTE_DIRECT_EDIT_PROVIDER
Key to identify the direct edit provider instance. |
static java.lang.String |
ATTRIBUTE_DIRECT_EDIT_PROVIDER_PARAMS
Key to identify the direct edit provider parameteres. |
Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler |
ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD |
Method Summary | |
void |
init(CmsObject cms,
CmsDirectEditMode mode,
java.lang.String fileName)
Initialize method for a new instance of the direct edit provider. |
void |
insertDirectEditEnd(javax.servlet.jsp.PageContext context)
Inserts the "end direct edit" HTML in the provided JSP page context. |
void |
insertDirectEditIncludes(javax.servlet.jsp.PageContext context,
CmsDirectEditParams params)
Inserts the "direct edit header" HTML in the provided JSP page context. |
boolean |
insertDirectEditStart(javax.servlet.jsp.PageContext context,
CmsDirectEditParams params)
Inserts the "start direct edit" HTML in the provided JSP page context. |
boolean |
isManual(CmsDirectEditMode mode)
Returns true if this provider (currently) operates in manual mode. |
I_CmsDirectEditProvider |
newInstance()
Creates a new instance of this direct edit provider with the same basic configuration. |
Methods inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler |
addConfigurationParameter, getConfiguration, initConfiguration |
Field Detail |
public static final java.lang.String ATTRIBUTE_DIRECT_EDIT_PROVIDER
public static final java.lang.String ATTRIBUTE_DIRECT_EDIT_PROVIDER_PARAMS
Method Detail |
public void init(CmsObject cms, CmsDirectEditMode mode, java.lang.String fileName)
cms
- the current users OpenCms contextmode
- the direct edit mode to usefileName
- link to a file that contains the direct edit HTML elements (optional)public void insertDirectEditEnd(javax.servlet.jsp.PageContext context) throws javax.servlet.jsp.JspException
context
- the JSP page context to insert the HTML to
javax.servlet.jsp.JspException
- in case something goes wrongpublic void insertDirectEditIncludes(javax.servlet.jsp.PageContext context, CmsDirectEditParams params) throws javax.servlet.jsp.JspException
context
- the JSP page context to insert the HTML toparams
- the parameters for the direct edit includes
javax.servlet.jsp.JspException
- in case something goes wrongpublic boolean insertDirectEditStart(javax.servlet.jsp.PageContext context, CmsDirectEditParams params) throws javax.servlet.jsp.JspException
context
- the JSP page context to insert the HTML toparams
- the parameters for the direct edit call
true
in case a direct edit element was opened, false
otherwise
javax.servlet.jsp.JspException
- in case something goes wrongpublic boolean isManual(CmsDirectEditMode mode)
true
if this provider (currently) operates in manual mode.
In manual mode the direct edit HTML is inserted with <cms:enditable mode="manual" />
tags. Otherwise the direct edit HTML is automatically inserted in the current page.
Some providers may not be able to operate in manual mode. These will always return false
.
mode
- the mode of the current direct edit element
true
if this provider (currently) operates in manual modepublic I_CmsDirectEditProvider newInstance()
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |