Class CmsDirectEditDefaultProvider
- java.lang.Object
-
- org.opencms.workplace.editors.directedit.A_CmsDirectEditProvider
-
- org.opencms.workplace.editors.directedit.CmsDirectEditDefaultProvider
-
- All Implemented Interfaces:
java.lang.Cloneable
,I_CmsConfigurationParameterHandler
,I_CmsDirectEditProvider
- Direct Known Subclasses:
CmsDirectEditJQueryProvider
,CmsDirectEditTextButtonProvider
public class CmsDirectEditDefaultProvider extends A_CmsDirectEditProvider
Provider for the OpenCms default graphical "direct edit" buttons.Since OpenCms version 6.2.3, this provider is configured as the standard direct edit provider in a common OpenCms installation.
This provider DOES NOT support
CmsDirectEditMode.MANUAL
mode.- Since:
- 6.2.3
-
-
Field Summary
Fields Modifier and Type Field Description protected int
m_lastPermissionMode
Indicates the permissions for the last element the was opened.-
Fields inherited from class org.opencms.workplace.editors.directedit.A_CmsDirectEditProvider
INCLUDE_FILE_DEFAULT, m_cms, m_configurationParameters, m_editButtonStyle, m_fileName, m_messages, m_mode, m_rnd
-
Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler
ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD
-
Fields inherited from interface org.opencms.workplace.editors.directedit.I_CmsDirectEditProvider
ATTRIBUTE_DIRECT_EDIT_PROVIDER, ATTRIBUTE_DIRECT_EDIT_PROVIDER_PARAMS
-
-
Constructor Summary
Constructors Constructor Description CmsDirectEditDefaultProvider()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
endDirectEditDisabled()
Returns the end HTML for a disabled direct edit button.java.lang.String
endDirectEditEnabled()
Returns the end HTML for an enabled direct edit button.protected java.lang.String
getContentAsString(CmsFile file)
Helper method to convert the content of a resource to a string.java.lang.String
getDirectEditIncludes(CmsDirectEditParams params)
Returns the direct edit include HTML to insert in the page beginning.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)
Returnsfalse
because the default provider does not support manual button placement.I_CmsDirectEditProvider
newInstance()
Creates a new instance of this direct edit provider with the same basic configuration.protected CmsMacroResolver
prepareMacroResolverForIncludes(CmsDirectEditParams params)
Prepares the macro resolver which is used to process the included text file.java.lang.String
startDirectEditDisabled(CmsDirectEditParams params, CmsDirectEditResourceInfo resourceInfo)
Returns the start HTML for a disabled direct edit button.java.lang.String
startDirectEditEnabled(CmsDirectEditParams params, CmsDirectEditResourceInfo resourceInfo)
Returns the start HTML for an enabled direct edit button.-
Methods inherited from class org.opencms.workplace.editors.directedit.A_CmsDirectEditProvider
addConfigurationParameter, getConfiguration, getLink, getNextDirectEditId, getResourceInfo, initConfiguration, insertDirectEditEmptyList, insertDirectEditListMetadata, print
-
-
-
-
Field Detail
-
m_lastPermissionMode
protected int m_lastPermissionMode
Indicates the permissions for the last element the was opened.
-
-
Constructor Detail
-
CmsDirectEditDefaultProvider
public CmsDirectEditDefaultProvider()
-
-
Method Detail
-
endDirectEditDisabled
public java.lang.String endDirectEditDisabled()
Returns the end HTML for a disabled direct edit button.- Returns:
- the end HTML for a disabled direct edit button
-
endDirectEditEnabled
public java.lang.String endDirectEditEnabled()
Returns the end HTML for an enabled direct edit button.- Returns:
- the end HTML for an enabled direct edit button
-
getDirectEditIncludes
public java.lang.String getDirectEditIncludes(CmsDirectEditParams params)
Returns the direct edit include HTML to insert in the page beginning.t
- Parameters:
params
- the parameters for the direct edit includes- Returns:
- the direct edit include HTML to insert in the page beginning
-
init
public void init(CmsObject cms, CmsDirectEditMode mode, java.lang.String fileName)
Description copied from interface:I_CmsDirectEditProvider
Initialize method for a new instance of the direct edit provider.- Specified by:
init
in interfaceI_CmsDirectEditProvider
- Overrides:
init
in classA_CmsDirectEditProvider
- Parameters:
cms
- the current users OpenCms contextmode
- the direct edit mode to usefileName
- link to a file that contains the direct edit HTML elements (optional)- See Also:
A_CmsDirectEditProvider.init(org.opencms.file.CmsObject, org.opencms.workplace.editors.directedit.CmsDirectEditMode, java.lang.String)
-
insertDirectEditEnd
public void insertDirectEditEnd(javax.servlet.jsp.PageContext context) throws javax.servlet.jsp.JspException
Description copied from interface:I_CmsDirectEditProvider
Inserts the "end direct edit" HTML in the provided JSP page context.- Parameters:
context
- the JSP page context to insert the HTML to- Throws:
javax.servlet.jsp.JspException
- in case something goes wrong- See Also:
I_CmsDirectEditProvider.insertDirectEditEnd(javax.servlet.jsp.PageContext)
-
insertDirectEditIncludes
public void insertDirectEditIncludes(javax.servlet.jsp.PageContext context, CmsDirectEditParams params) throws javax.servlet.jsp.JspException
Description copied from interface:I_CmsDirectEditProvider
Inserts the "direct edit header" HTML in the provided JSP page context.- Parameters:
context
- the JSP page context to insert the HTML toparams
- the parameters for the direct edit includes- Throws:
javax.servlet.jsp.JspException
- in case something goes wrong- See Also:
I_CmsDirectEditProvider.insertDirectEditIncludes(javax.servlet.jsp.PageContext, org.opencms.workplace.editors.directedit.CmsDirectEditParams)
-
insertDirectEditStart
public boolean insertDirectEditStart(javax.servlet.jsp.PageContext context, CmsDirectEditParams params) throws javax.servlet.jsp.JspException
Description copied from interface:I_CmsDirectEditProvider
Inserts the "start direct edit" HTML in the provided JSP page context.- Parameters:
context
- the JSP page context to insert the HTML toparams
- the parameters for the direct edit call- Returns:
true
in case a direct edit element was opened,false
otherwise- Throws:
javax.servlet.jsp.JspException
- in case something goes wrong- See Also:
I_CmsDirectEditProvider.insertDirectEditStart(javax.servlet.jsp.PageContext, org.opencms.workplace.editors.directedit.CmsDirectEditParams)
-
isManual
public boolean isManual(CmsDirectEditMode mode)
Returnsfalse
because the default provider does not support manual button placement.- Specified by:
isManual
in interfaceI_CmsDirectEditProvider
- Overrides:
isManual
in classA_CmsDirectEditProvider
- Parameters:
mode
- the mode of the current direct edit element- Returns:
true
if this provider (currently) operates in manual mode- See Also:
I_CmsDirectEditProvider.isManual(org.opencms.workplace.editors.directedit.CmsDirectEditMode)
-
newInstance
public I_CmsDirectEditProvider newInstance()
Description copied from interface:I_CmsDirectEditProvider
Creates a new instance of this direct edit provider with the same basic configuration.- Returns:
- a new instance of this direct edit provider with the same basic configuration
- See Also:
I_CmsDirectEditProvider.newInstance()
-
startDirectEditDisabled
public java.lang.String startDirectEditDisabled(CmsDirectEditParams params, CmsDirectEditResourceInfo resourceInfo)
Returns the start HTML for a disabled direct edit button.- Parameters:
params
- the direct edit parametersresourceInfo
- contains information about the resource to edit- Returns:
- the start HTML for a disabled direct edit button
-
startDirectEditEnabled
public java.lang.String startDirectEditEnabled(CmsDirectEditParams params, CmsDirectEditResourceInfo resourceInfo)
Returns the start HTML for an enabled direct edit button.- Parameters:
params
- the direct edit parametersresourceInfo
- contains information about the resource to edit- Returns:
- the start HTML for an enabled direct edit button
-
getContentAsString
protected java.lang.String getContentAsString(CmsFile file) throws CmsException
Helper method to convert the content of a resource to a string.- Parameters:
file
- the file- Returns:
- the file content as a string
- Throws:
CmsException
- if something goes wrong
-
prepareMacroResolverForIncludes
protected CmsMacroResolver prepareMacroResolverForIncludes(CmsDirectEditParams params)
Prepares the macro resolver which is used to process the included text file.- Parameters:
params
- the direct edit parameters- Returns:
- the macro resolver
-
-