org.opencms.ade.editprovider
Class CmsToolbarDirectEditProvider

java.lang.Object
  extended by org.opencms.workplace.editors.directedit.A_CmsDirectEditProvider
      extended by org.opencms.workplace.editors.directedit.CmsAdvancedDirectEditProvider
          extended by org.opencms.ade.editprovider.CmsToolbarDirectEditProvider
All Implemented Interfaces:
Cloneable, I_CmsConfigurationParameterHandler, I_CmsDirectEditProvider

public class CmsToolbarDirectEditProvider
extends CmsAdvancedDirectEditProvider

A Direct Edit provider class which also offers some limited ADE functionality, like for example the Publish dialog.

Since:
8.0.0

Field Summary
static String MODULE_NAME
          The module name.
 
Fields inherited from class org.opencms.workplace.editors.directedit.CmsAdvancedDirectEditProvider
m_lastPermissionMode, m_useIds
 
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.workplace.editors.directedit.I_CmsDirectEditProvider
ATTRIBUTE_DIRECT_EDIT_PROVIDER, ATTRIBUTE_DIRECT_EDIT_PROVIDER_PARAMS
 
Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler
ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD
 
Constructor Summary
CmsToolbarDirectEditProvider()
          Creates a new instance of this direct edit provider.
 
Method Summary
 String getIncludes(javax.servlet.jsp.PageContext context, CmsDirectEditParams params)
          Returns the direct edit include HTML to insert in the page beginning.
 void insertDirectEditIncludes(javax.servlet.jsp.PageContext context, CmsDirectEditParams params)
          Inserts the "direct edit header" HTML in the provided JSP page context.
 I_CmsDirectEditProvider newInstance()
          Creates a new instance of this direct edit provider with the same basic configuration.
 
Methods inherited from class org.opencms.workplace.editors.directedit.CmsAdvancedDirectEditProvider
endDirectEditDisabled, endDirectEditEnabled, getRandomId, insertDirectEditEnd, insertDirectEditStart, isManual, startDirectEditDisabled, startDirectEditEnabled
 
Methods inherited from class org.opencms.workplace.editors.directedit.A_CmsDirectEditProvider
addConfigurationParameter, getConfiguration, getLink, getNextDirectEditId, getResourceInfo, init, initConfiguration, print
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MODULE_NAME

public static final String MODULE_NAME
The module name.

See Also:
Constant Field Values
Constructor Detail

CmsToolbarDirectEditProvider

public CmsToolbarDirectEditProvider()
Creates a new instance of this direct edit provider.

Method Detail

getIncludes

public String getIncludes(javax.servlet.jsp.PageContext context,
                          CmsDirectEditParams params)
                   throws Exception
Returns the direct edit include HTML to insert in the page beginning.

Parameters:
context - the page context
params - the parameters for the direct edit includes
Returns:
the direct edit include HTML to insert in the page beginning
Throws:
Exception - if something goes wrong

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.

Specified by:
insertDirectEditIncludes in interface I_CmsDirectEditProvider
Overrides:
insertDirectEditIncludes in class CmsAdvancedDirectEditProvider
Parameters:
context - the JSP page context to insert the HTML to
params - 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)

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.

Specified by:
newInstance in interface I_CmsDirectEditProvider
Overrides:
newInstance in class CmsAdvancedDirectEditProvider
Returns:
a new instance of this direct edit provider with the same basic configuration
See Also:
I_CmsDirectEditProvider.newInstance()