Package io.goobi.viewer.model.cms.pages.content

Enum Class CMSComponentScope

java.lang.Object

java.lang.Enum<CMSComponentScope>

io.goobi.viewer.model.cms.pages.content.CMSComponentScope

All Implemented Interfaces:

Serializable, Comparable<CMSComponentScope>, Constable

public enum CMSComponentScope
extends Enum<CMSComponentScope>

Defines the rendering context in which a CMS component is visible.

• PREVIEW – shown in an embedded preview of the page within another page
• PAGEHEADER – displayed in the page header area
• PAGEVIEW – shown when the page is displayed directly (full view)

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
PAGEHEADER	Component is displayed in the header of the page.
PAGEVIEW	Component is visible when its owning page is displayed directly.
PREVIEW	Component is visible in a preview of its owning page embedded within another page.

Method Summary

Modifier and Type	Method	Description
static CMSComponentScope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CMSComponentScope[]	values()	Returns an array containing the constants of this enum class, 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

PREVIEW

public static final CMSComponentScope PREVIEW

Component is visible in a preview of its owning page embedded within another page.

PAGEHEADER

public static final CMSComponentScope PAGEHEADER

Component is displayed in the header of the page.

PAGEVIEW

public static final CMSComponentScope PAGEVIEW

Component is visible when its owning page is displayed directly.

Method Details

values

public static CMSComponentScope[] values()

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

Returns:

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

valueOf

public static CMSComponentScope valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null