org.opencms.workplace.editors.directedit
Class CmsDirectEditJQueryProvider

java.lang.Object
  extended byorg.opencms.workplace.editors.directedit.A_CmsDirectEditProvider
      extended byorg.opencms.workplace.editors.directedit.CmsDirectEditDefaultProvider
          extended byorg.opencms.workplace.editors.directedit.CmsDirectEditJQueryProvider
All Implemented Interfaces:
java.lang.Cloneable, I_CmsConfigurationParameterHandler, I_CmsDirectEditProvider

public class CmsDirectEditJQueryProvider
extends CmsDirectEditDefaultProvider

Provider for the OpenCms graphical "direct edit" buttons.

Uses the JQuery library to create the buttons and place it to the correct position.

This provider DOES NOT support CmsDirectEditMode.MANUAL mode.

Since:
7.0.3
Version:
$Revision: 1.2 $
Author:
Anja Röttgers

Field Summary
protected static java.lang.String INCLUDE_FILE_JQUERY
          Default direct edit include file URI for the jQuery direct edit provider.
 
Fields inherited from class org.opencms.workplace.editors.directedit.CmsDirectEditDefaultProvider
m_lastPermissionMode
 
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
CmsDirectEditJQueryProvider()
           
 
Method Summary
 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.
 I_CmsDirectEditProvider newInstance()
          Creates a new instance of this direct edit provider with the same basic configuration.
 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.CmsDirectEditDefaultProvider
endDirectEditDisabled, endDirectEditEnabled, insertDirectEditEnd, insertDirectEditIncludes, insertDirectEditStart, isManual
 
Methods inherited from class org.opencms.workplace.editors.directedit.A_CmsDirectEditProvider
addConfigurationParameter, getConfiguration, getLink, getNextDirectEditId, getResourceInfo, initConfiguration, print
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler
addConfigurationParameter, getConfiguration, initConfiguration
 

Field Detail

INCLUDE_FILE_JQUERY

protected static final java.lang.String INCLUDE_FILE_JQUERY
Default direct edit include file URI for the jQuery direct edit provider.

See Also:
Constant Field Values
Constructor Detail

CmsDirectEditJQueryProvider

public CmsDirectEditJQueryProvider()
Method Detail

getDirectEditIncludes

public java.lang.String getDirectEditIncludes(CmsDirectEditParams params)
Description copied from class: CmsDirectEditDefaultProvider
Returns the direct edit include HTML to insert in the page beginning.

t

Overrides:
getDirectEditIncludes in class CmsDirectEditDefaultProvider
Parameters:
params - the parameters for the direct edit includes
Returns:
the direct edit include HTML to insert in the page beginning
See Also:
CmsDirectEditDefaultProvider.getDirectEditIncludes(org.opencms.workplace.editors.directedit.CmsDirectEditParams)

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 interface I_CmsDirectEditProvider
Overrides:
init in class CmsDirectEditDefaultProvider
See Also:
I_CmsDirectEditProvider.init(org.opencms.file.CmsObject, org.opencms.workplace.editors.directedit.CmsDirectEditMode, java.lang.String)

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 CmsDirectEditDefaultProvider
See Also:
I_CmsDirectEditProvider.newInstance()

startDirectEditDisabled

public java.lang.String startDirectEditDisabled(CmsDirectEditParams params,
                                                CmsDirectEditResourceInfo resourceInfo)
Description copied from class: CmsDirectEditDefaultProvider
Returns the start HTML for a disabled direct edit button.

Overrides:
startDirectEditDisabled in class CmsDirectEditDefaultProvider
Parameters:
params - the direct edit parameters
resourceInfo - contains information about the resource to edit
Returns:
the start HTML for a disabled direct edit button
See Also:
CmsDirectEditDefaultProvider.startDirectEditDisabled(org.opencms.workplace.editors.directedit.CmsDirectEditParams, org.opencms.workplace.editors.directedit.CmsDirectEditResourceInfo)

startDirectEditEnabled

public java.lang.String startDirectEditEnabled(CmsDirectEditParams params,
                                               CmsDirectEditResourceInfo resourceInfo)
Description copied from class: CmsDirectEditDefaultProvider
Returns the start HTML for an enabled direct edit button.

Overrides:
startDirectEditEnabled in class CmsDirectEditDefaultProvider
Parameters:
params - the direct edit parameters
resourceInfo - contains information about the resource to edit
Returns:
the start HTML for an enabled direct edit button
See Also:
CmsDirectEditDefaultProvider.startDirectEditEnabled(org.opencms.workplace.editors.directedit.CmsDirectEditParams, org.opencms.workplace.editors.directedit.CmsDirectEditResourceInfo)