Package limn.components

Enum Class Elevation

java.lang.Object

java.lang.Enum<Elevation>

limn.components.Elevation

All Implemented Interfaces:

Serializable, Comparable<Elevation>, Constable

public enum Elevation
extends Enum<Elevation>

How far a surface is lifted above what is around it. A widget says which of these it is, and the theme says what that looks like: Theme.elevation(Elevation).

Four, named for what the surface is and not numbered: a level that cannot be told from its neighbour on a screen is a level to get wrong.

A 1.x minor release may add constants to this enum: a switch over it needs a default branch.

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
FLAT	In the plane of what is around it: a pane, a window's content.
MODAL	Covers the window until it is answered: a dialog.
OVERLAY	Covers what is under it for a while: a menu, the list of a combo box, a calendar, a tooltip, a panel that slides in over content.
RAISED	A part of the page set a little above it: a card with no edge, a bar that floats.

Method Summary

Modifier and Type	Method	Description
static Elevation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Elevation[]	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

FLAT

public static final Elevation FLAT

In the plane of what is around it: a pane, a window's content. Casts nothing.

RAISED

public static final Elevation RAISED

A part of the page set a little above it: a card with no edge, a bar that floats.

OVERLAY

public static final Elevation OVERLAY

Covers what is under it for a while: a menu, the list of a combo box, a calendar, a tooltip, a panel that slides in over content.

MODAL

public static final Elevation MODAL

Covers the window until it is answered: a dialog.

Method Details

values

public static Elevation[] 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 Elevation 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