Package org.opencms.xml.content

Enum CmsXmlContentProperty.Visibility

java.lang.Object

java.lang.Enum<CmsXmlContentProperty.Visibility>

org.opencms.xml.content.CmsXmlContentProperty.Visibility

All Implemented Interfaces:

Serializable, Comparable<CmsXmlContentProperty.Visibility>, java.lang.constant.Constable

Enclosing class:

CmsXmlContentProperty

public static enum CmsXmlContentProperty.Visibility
extends Enum<CmsXmlContentProperty.Visibility>

The property visibility options.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
element	Visible only on the element.
elementAndParentIndividual	Visible in both element and list parent as an individual setting.
elementAndParentShared	Visible in both element and list parent as a shared setting.
parentIndividual	Visible only on list parent, as individual setting.
parentShared	Visible only on list parent, as shared setting.

Method Summary

Modifier and Type	Method	Description
boolean	isVisibleOnElement()	True if it should be visible on the element itself.
static CmsXmlContentProperty.Visibility	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CmsXmlContentProperty.Visibility[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

element

public static final CmsXmlContentProperty.Visibility element

Visible only on the element.

elementAndParentIndividual

public static final CmsXmlContentProperty.Visibility elementAndParentIndividual

Visible in both element and list parent as an individual setting.

elementAndParentShared

public static final CmsXmlContentProperty.Visibility elementAndParentShared

Visible in both element and list parent as a shared setting.

parentIndividual

public static final CmsXmlContentProperty.Visibility parentIndividual

Visible only on list parent, as individual setting.

parentShared

public static final CmsXmlContentProperty.Visibility parentShared

Visible only on list parent, as shared setting.

Method Details

values

public static CmsXmlContentProperty.Visibility[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CmsXmlContentProperty.Visibility valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isVisibleOnElement

public boolean isVisibleOnElement()

True if it should be visible on the element itself.

Returns:

true if visible on the element