org.opencms.workplace.editors.directedit

类 CmsDirectEditMode

java.lang.Object

org.opencms.workplace.editors.directedit.CmsDirectEditMode

public final class CmsDirectEditMode
extends java.lang.Object

Constants to indicate which mode to use for placement of the HTML that generates the direct edit buttons.

There are 3 basic options for the direct edit mode:

• FALSE: Direct edit is disabled.
• AUTO: Direct edit button HTML is inserted automatically.
• MANUAL: Direct edit button HTML is inserted manually by using <cms: editable mode="manual" /> tags.

There is one global option set for the page / template. The default is AUTO.

There is an additional constant TRUE that means "use the default mode of the page / template".

It is possible to switch modes for an individual content loop. This is intended to use with XmlContents that require special placement of the direct edit HTML because the default placement does not give good results.

从以下版本开始:

6.2.3

字段概要

字段

限定符和类型	字段和说明
static CmsDirectEditMode	AUTO Indicates automatic placement of direct edit HTML.
static CmsDirectEditMode	FALSE Indicates direct edit is disabled.
static CmsDirectEditMode	MANUAL Indicates manual placement of direct edit HTML.
static CmsDirectEditMode	TRUE Indicates direct edit HTML is to be generated according to the default setting of the current page.

方法概要

方法

限定符和类型	方法和说明
int	getMode() Returns this modes int value.
boolean	isEnabled() Returns true in case this mode indicates direct edit is enabled.
java.lang.String	toString()
static CmsDirectEditMode	valueOf(boolean value) Returns TRUE in case the given value is true, FALSE otherwise.
static CmsDirectEditMode	valueOf(int mode) Returns the mode constant for the selected direct edit int mode.
static CmsDirectEditMode	valueOf(java.lang.String value) Returns the mode constant for the selected direct edit String mode description.

从类继承的方法 java.lang.Object

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

字段详细资料

AUTO

public static final CmsDirectEditMode AUTO

Indicates automatic placement of direct edit HTML.

FALSE

public static final CmsDirectEditMode FALSE

Indicates direct edit is disabled.

MANUAL

public static final CmsDirectEditMode MANUAL

Indicates manual placement of direct edit HTML.

TRUE

public static final CmsDirectEditMode TRUE

Indicates direct edit HTML is to be generated according to the default setting of the current page.

方法详细资料

valueOf

public static CmsDirectEditMode valueOf(boolean value)

Returns TRUE in case the given value is true, FALSE otherwise.

参数:

value - the direct edit mode to get the constant for

返回:

TRUE in case the given value is true, FALSE otherwise

valueOf

public static CmsDirectEditMode valueOf(int mode)

Returns the mode constant for the selected direct edit int mode.

The possible value are:

• 0: Mode is FALSE.
• 1: Mode is TRUE.
• 2: Mode is AUTO.
• 3: Mode is MANUAL.

参数:

mode - the direct edit int mode to get the constant for

返回:

the mode constant for the selected direct edit int mode

valueOf

public static CmsDirectEditMode valueOf(java.lang.String value)

Returns the mode constant for the selected direct edit String mode description.

For a mode instance A, toString() returns the String mode description.

参数:

value - the direct edit String mode description to get the constant for

返回:

the mode constant for the selected direct edit String mode description

getMode

public int getMode()

Returns this modes int value.

返回:

this modes int value

另请参阅:

valueOf(int)

isEnabled

public boolean isEnabled()

Returns true in case this mode indicates direct edit is enabled.

Direct edit is enabled if this mode is not FALSE, which is identical to getMode() > 0.

返回:

true in case this mode indicates direct edit is enabled

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object

另请参阅:

Object.toString(), valueOf(String)