com.android.resources
Enum ScreenOrientation

java.lang.Object
  java.lang.Enum<ScreenOrientation>
      com.android.resources.ScreenOrientation

All Implemented Interfaces:

ResourceEnum, java.io.Serializable, java.lang.Comparable<ScreenOrientation>

public enum ScreenOrientation
extends java.lang.Enum<ScreenOrientation>
implements ResourceEnum

Screen Orientation enum.

This is used in the manifest in the uses-configuration node and in the resource folder names.

Enum Constant Summary

LANDSCAPE

PORTRAIT

SQUARE

Method Summary

static ScreenOrientation	getByIndex(int index)
static ScreenOrientation	getByShortDisplayName(java.lang.String name)
static ScreenOrientation	getEnum(java.lang.String value) Returns the enum for matching the provided qualifier value.
static int	getIndex(ScreenOrientation orientation)
java.lang.String	getLongDisplayValue() Returns a long string for display value.
java.lang.String	getResourceValue() Returns the resource string.
java.lang.String	getShortDisplayValue() Returns a short string for display value.
boolean	isFakeValue() Whether the value is neither used for device nor resources.
boolean	isValidValueForDevice() Whether the value actually used on device.
static ScreenOrientation	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ScreenOrientation[]	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

PORTRAIT

public static final ScreenOrientation PORTRAIT

LANDSCAPE

public static final ScreenOrientation LANDSCAPE

SQUARE

public static final ScreenOrientation SQUARE

Method Detail

values

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

Returns:

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

valueOf

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

getEnum

public static ScreenOrientation getEnum(java.lang.String value)

Returns the enum for matching the provided qualifier value.

Parameters:

value - The qualifier value.

Returns:

the enum for the qualifier value or null if no matching was found.

getResourceValue

public java.lang.String getResourceValue()

Description copied from interface: ResourceEnum

Returns the resource string. This is to be used in resource folder names.

Specified by:

getResourceValue in interface ResourceEnum

getShortDisplayValue

public java.lang.String getShortDisplayValue()

Description copied from interface: ResourceEnum

Returns a short string for display value. The string does not need to show the context.

For instance "exposed", which can be the value for the keyboard state or the navigation state, would be valid since something else in the UI is expected to show if this is about the keyboard or the navigation state.

Specified by:

getShortDisplayValue in interface ResourceEnum

See Also:

ResourceEnum.getLongDisplayValue()

getLongDisplayValue

public java.lang.String getLongDisplayValue()

Description copied from interface: ResourceEnum

Returns a long string for display value. This must not only include the enum value but context (qualifier) about what the value represents.

For instance "Exposed keyboard", and "Export navigation", as "exposed" would not be enough to know what qualifier the value is about.

Specified by:

getLongDisplayValue in interface ResourceEnum

See Also:

ResourceEnum.getShortDisplayValue()

getIndex

public static int getIndex(ScreenOrientation orientation)

getByIndex

public static ScreenOrientation getByIndex(int index)

getByShortDisplayName

public static ScreenOrientation getByShortDisplayName(java.lang.String name)

isFakeValue

public boolean isFakeValue()

Description copied from interface: ResourceEnum

Whether the value is neither used for device nor resources. This returns false when the value is only used for internal usage in the custom editors.

Specified by:

isFakeValue in interface ResourceEnum

isValidValueForDevice

public boolean isValidValueForDevice()

Description copied from interface: ResourceEnum

Whether the value actually used on device. This returns true only if a device can report this value, false if it's just used to qualify resources.

Specified by:

isValidValueForDevice in interface ResourceEnum