|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.workplace.editors.directedit.CmsDirectEditMode
public final class CmsDirectEditMode
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.
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.
Field Summary | |
---|---|
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. |
Method Summary | |
---|---|
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final CmsDirectEditMode AUTO
public static final CmsDirectEditMode FALSE
public static final CmsDirectEditMode MANUAL
public static final CmsDirectEditMode TRUE
Method Detail |
---|
public static CmsDirectEditMode valueOf(boolean value)
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
otherwisepublic static CmsDirectEditMode valueOf(int mode)
The possible value are:
mode
- the direct edit int mode to get the constant for
public static CmsDirectEditMode valueOf(java.lang.String value)
For a mode instance A
, toString()
returns the String mode description.
value
- the direct edit String mode description to get the constant for
public int getMode()
valueOf(int)
public boolean isEnabled()
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 enabledpublic java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
,
valueOf(String)
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |