Package org.opencms.workplace.editors.directedit

Class CmsDirectEditTextButtonProvider

java.lang.Object

org.opencms.workplace.editors.directedit.A_CmsDirectEditProvider

org.opencms.workplace.editors.directedit.CmsDirectEditDefaultProvider

org.opencms.workplace.editors.directedit.CmsDirectEditTextButtonProvider

All Implemented Interfaces:

java.lang.Cloneable, I_CmsConfigurationParameterHandler, I_CmsDirectEditProvider

public class CmsDirectEditTextButtonProvider
extends CmsDirectEditDefaultProvider

Creates HTML for simple text based direct edit buttons.

This provider support CmsDirectEditMode.MANUAL mode.

Since:

6.2.3

Field Summary

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.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
CmsDirectEditTextButtonProvider()

Method Summary

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.
boolean	isManual(CmsDirectEditMode mode)	Returns false 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.
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

getContentAsString, getDirectEditIncludes, init, insertDirectEditEnd, insertDirectEditIncludes, insertDirectEditStart, prepareMacroResolverForIncludes

Methods inherited from class org.opencms.workplace.editors.directedit.A_CmsDirectEditProvider

addConfigurationParameter, getConfiguration, getLink, getNextDirectEditId, getResourceInfo, initConfiguration, insertDirectEditEmptyList, insertDirectEditListMetadata, print

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CmsDirectEditTextButtonProvider

public CmsDirectEditTextButtonProvider()

Method Detail

endDirectEditDisabled

public java.lang.String endDirectEditDisabled()

Description copied from class: CmsDirectEditDefaultProvider

Returns the end HTML for a disabled direct edit button.

Overrides:

endDirectEditDisabled in class CmsDirectEditDefaultProvider

Returns:

the end HTML for a disabled direct edit button

See Also:

CmsDirectEditDefaultProvider.endDirectEditDisabled()

endDirectEditEnabled

public java.lang.String endDirectEditEnabled()

Description copied from class: CmsDirectEditDefaultProvider

Returns the end HTML for an enabled direct edit button.

Overrides:

endDirectEditEnabled in class CmsDirectEditDefaultProvider

Returns:

the end HTML for an enabled direct edit button

See Also:

CmsDirectEditDefaultProvider.endDirectEditEnabled()

isManual

public boolean isManual(CmsDirectEditMode mode)

Description copied from class: CmsDirectEditDefaultProvider

Returns false because the default provider does not support manual button placement.

Specified by:

isManual in interface I_CmsDirectEditProvider

Overrides:

isManual in class CmsDirectEditDefaultProvider

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.

Specified by:

newInstance in interface I_CmsDirectEditProvider

Overrides:

newInstance in class CmsDirectEditDefaultProvider

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)

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)