org.opencms.ui.util

Enum CmsDisplayType

java.lang.Object

java.lang.Enum<CmsDisplayType>

org.opencms.ui.util.CmsDisplayType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CmsDisplayType>

public enum CmsDisplayType
extends java.lang.Enum<CmsDisplayType>

Represents the three possible display types (small, medium, wide).

Enum Constant Summary

Enum Constants

Enum Constant and Description
medium Medium.
small Small.
wide Wide.

Method Summary

Modifier and Type	Method and Description
static CmsDisplayType	getDisplayType(int width) Gets the display type corresponding to a given width.
int	minWidth() Gets the minimum window width for this size.
static CmsDisplayType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CmsDisplayType[]	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

Enum Constant Detail

wide

public static final CmsDisplayType wide

Wide.

medium

public static final CmsDisplayType medium

Medium. *s

small

public static final CmsDisplayType small

Small.

Method Detail

values

public static CmsDisplayType[] 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 (CmsDisplayType c : CmsDisplayType.values())
    System.out.println(c);

Returns:

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

valueOf

public static CmsDisplayType valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getDisplayType

public static CmsDisplayType getDisplayType(int width)

Gets the display type corresponding to a given width.

Parameters:

width - the window width

Returns:

the matching display type

minWidth

public int minWidth()

Gets the minimum window width for this size.

Returns:

the minimum window width