com.smartdevicelink.proxy.rpc.enums

Enum PredefinedWindows

java.lang.Object

java.lang.Enum<PredefinedWindows>

com.smartdevicelink.proxy.rpc.enums.PredefinedWindows

All Implemented Interfaces:

Serializable, Comparable<PredefinedWindows>

public enum PredefinedWindows
extends Enum<PredefinedWindows>

specifies what windows and IDs are predefined and pre-created on behalf of the app.

The default window is always available and represents the app window on the main display. It's an equivalent to today's app window. For backward compatibility, this will ensure the app always has at least the default window on the main display. The app can choose to use this predefined enum element to specifically address app's main window or to duplicate window content. It is not possible to duplicate another window to the default window.

The primary widget is a special widget, that can be associated with a service type, which is used by the HMI whenever a single widget needs to represent the whole app. The primary widget should be named as the app and can be pre-created by the HMI

Since:

6.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT_WINDOW The default window is a main window pre-created on behalf of the app.
PRIMARY_WIDGET The primary widget of the app.

Method Summary

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

DEFAULT_WINDOW

public static final PredefinedWindows DEFAULT_WINDOW

The default window is a main window pre-created on behalf of the app.

PRIMARY_WIDGET

public static final PredefinedWindows PRIMARY_WIDGET

The primary widget of the app.

Method Detail

values

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

Returns:

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

valueOf

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

valueForInt

public static PredefinedWindows valueForInt(int value)

getValue

public int getValue()