com.redhat.thermostat.client.swing

Enum ReferenceFieldDecoratorLayout

java.lang.Object

java.lang.Enum<ReferenceFieldDecoratorLayout>

com.redhat.thermostat.client.swing.ReferenceFieldDecoratorLayout

All Implemented Interfaces:

Serializable, Comparable<ReferenceFieldDecoratorLayout>

public enum ReferenceFieldDecoratorLayout
extends Enum<ReferenceFieldDecoratorLayout>

This Enum marks Decorator target for ReferenceFieldLabelDecorators and ReferenceFieldIconDecorators. Each of those entry point represent a visual element in the reference list component for the Swing based client.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ICON_MAIN Represents the main PlatformIcon portion of the entry to be decorated by ReferenceFieldIconDecorators.
LABEL_INFO Represents the secondary label portion to be decorated by ReferenceFieldLabelDecorator.
LABEL_MAIN Represents the main label portion to be decorated by ReferenceFieldLabelDecorators.

Method Summary

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

LABEL_MAIN

public static final ReferenceFieldDecoratorLayout LABEL_MAIN

Represents the main label portion to be decorated by ReferenceFieldLabelDecorators.

The main label is the top most field for each entry in the Refeference list, usually containing by default the name of the reference.

An example use for this field is the name of the target reference.

LABEL_INFO

public static final ReferenceFieldDecoratorLayout LABEL_INFO

Represents the secondary label portion to be decorated by ReferenceFieldLabelDecorator.

This label is usually a smaller and less obvious visual component that helps better define the actual entry. It should not contain too much information to avoid cluttering the UI.

An example use of this field is an unique ID of some kind.

ICON_MAIN

public static final ReferenceFieldDecoratorLayout ICON_MAIN

Represents the main PlatformIcon portion of the entry to be decorated by ReferenceFieldIconDecorators.

This icon is the main icon characterising the component being shown, for example representing a particular application or device.

Decorators registered for this entry point can cast PlatformIcon into Icon.

Note: since this client doesn't provide a default icon, plugins that apply for this decoration should check for a null PlatformIcon before using the input parameter.

Method Detail

values

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

Returns:

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

valueOf

public static ReferenceFieldDecoratorLayout 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