org.ka2ddo.yaac.pluginapi

Enum GuiContentType

java.lang.Object

java.lang.Enum<GuiContentType>

org.ka2ddo.yaac.pluginapi.GuiContentType

All Implemented Interfaces:

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

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

This enum defines content types for UI panels that can launch popup menus, to help popup menu actions decide whether they can be used in the launching context.

Author:

Andrew Pavlin, KA2DDO

See Also:

AbstractMenuAction, AbstractMenuAction.UI_TYPE

Enum Constant Summary

Enum Constants

Enum Constant and Description
BULLETIN GuiContentType of a UI displaying only APRS text messages that are broadcast bulletins.
LOCAL_OBJECTS GuiContentType of a tabular UI displaying locally originated Objects.
MAP GuiContentType of a geographical map display with stations and objects on it.
RAW_PACKETS GuiContentType of a tabular UI displaying raw frames, with the sending station's callsign in model column 1.
ROUTES Routes (used by the DynamicObjects plugin).
STATIONS GuiContentType of a tabular UI displaying the current status of stations and objects.
TEXT_MESSAGE GuiContentType of a UI displaying only APRS text messages (code ':').
WEATHER_ZONES GuiContentType of a tabular UI displaying current severe weather zones.

Method Summary

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

TEXT_MESSAGE

public static final GuiContentType TEXT_MESSAGE

GuiContentType of a UI displaying only APRS text messages (code ':').

BULLETIN

public static final GuiContentType BULLETIN

GuiContentType of a UI displaying only APRS text messages that are broadcast bulletins.

STATIONS

public static final GuiContentType STATIONS

GuiContentType of a tabular UI displaying the current status of stations and objects.

WEATHER_ZONES

public static final GuiContentType WEATHER_ZONES

GuiContentType of a tabular UI displaying current severe weather zones.

RAW_PACKETS

public static final GuiContentType RAW_PACKETS

GuiContentType of a tabular UI displaying raw frames, with the sending station's callsign in model column 1.

MAP

public static final GuiContentType MAP

GuiContentType of a geographical map display with stations and objects on it.

LOCAL_OBJECTS

public static final GuiContentType LOCAL_OBJECTS

GuiContentType of a tabular UI displaying locally originated Objects.

Since:

PROVIDER_API_VERSION == 36

ROUTES

public static final GuiContentType ROUTES

Routes (used by the DynamicObjects plugin).

Since:

PROVIDER_API_VERSION == 54

Method Detail

values

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

Returns:

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

valueOf

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