ThemeBackground (Cyclos 4.16.19 Scripting API Documentation)

java.lang.Object
- java.lang.Enum<ThemeBackground>
- - org.cyclos.model.contentmanagement.themes.ThemeBackground

All Implemented Interfaces:

Serializable, Comparable<ThemeBackground>, ThemeImageEnum, HasMessageKey
```
public enum ThemeBackground
extends Enum<ThemeBackground>
implements ThemeImageEnum, HasMessageKey
```
A background image used by a theme

Enum Constant Summary

Enum Constants
Enum Constant Description

CAPTCHA

NO_MAP

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`MessageKey`	`getMessageKey()`
`ThemeImageType`	`type()`
`static ThemeBackground`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static ThemeBackground[]`	`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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.cyclos.model.contentmanagement.themes.ThemeImageEnum
name

- Enum Constant Detail
  - CAPTCHA
```
public static final ThemeBackground CAPTCHA
```
  - NO_MAP
```
public static final ThemeBackground NO_MAP
```
- Method Detail
  - values
```
public static ThemeBackground[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (ThemeBackground c : ThemeBackground.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ThemeBackground 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
  - getMessageKey
```
public MessageKey getMessageKey()
```
    Specified by:
    
    getMessageKey in interface HasMessageKey
  - type
```
public ThemeImageType type()
```
    Specified by:
    
    type in interface ThemeImageEnum