Package limn.graphics

Enum Class Icon.Mirroring

java.lang.Object

java.lang.Enum<Icon.Mirroring>

limn.graphics.Icon.Mirroring

All Implemented Interfaces:

Serializable, Comparable<Icon.Mirroring>, Constable

Enclosing interface:

Icon

public static enum Icon.Mirroring
extends Enum<Icon.Mirroring>

Whether an icon turns around when the interface does.

The toolkit classifies nothing. Only the code that placed an icon knows whether its arrow means "back" (which mirrors), "download" (which does not), or is a shape inside a logo (which must not). An icon pack is an application's vocabulary, and a curated list of which of its glyphs are directional would be wrong for every application shipping its own.

NEVER is the default, and the asymmetry is deliberate: a wrong NEVER is one back-arrow pointing the wrong way in one place, and a wrong IN_RTL is every logo, brand mark, chart glyph and photograph in the application flipped.

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
IN_RTL	Flipped horizontally about its own box in a right-to-left subtree.
NEVER	Drawn as authored, whichever way the interface reads.

Method Summary

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

NEVER

public static final Icon.Mirroring NEVER

Drawn as authored, whichever way the interface reads. The default.

IN_RTL

public static final Icon.Mirroring IN_RTL

Flipped horizontally about its own box in a right-to-left subtree.

Method Details

values

public static Icon.Mirroring[] 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 Icon.Mirroring 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