com.jivesoftware.community.widget
Enum Widget.ContainerSize

java.lang.Object
  java.lang.Enum<Widget.ContainerSize>
      com.jivesoftware.community.widget.Widget.ContainerSize

All Implemented Interfaces:

Serializable, Comparable<Widget.ContainerSize>

Enclosing interface:

Widget

public static enum Widget.ContainerSize
extends Enum<Widget.ContainerSize>

Enumeration of the size of the parent container.

Enum Constant Summary

LARGE

SMALL

Method Summary

static Widget.ContainerSize	getContainerSize(long id) A helper method to get a specific container size from its ID.
long	getID()
static Widget.ContainerSize	valueOf(String name) Returns the enum constant of this type with the specified name.
static Widget.ContainerSize[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SMALL

public static final Widget.ContainerSize SMALL

LARGE

public static final Widget.ContainerSize LARGE

Method Detail

values

public static final Widget.ContainerSize[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(Widget.ContainerSize c : Widget.ContainerSize.values())
        System.out.println(c);

Returns:

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

valueOf

public static Widget.ContainerSize 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

getID

public long getID()

getContainerSize

public static Widget.ContainerSize getContainerSize(long id)

A helper method to get a specific container size from its ID.

Parameters:

id - the key value of the ContainerSize object

Returns:

the ContainerSize object corresponding to the key value. NULL if the key is invalid.