PredefinedLayout (sdl_android 5.3.1 API)

java.lang.Object
- java.lang.Enum<PredefinedLayout>
- - com.smartdevicelink.proxy.rpc.enums.PredefinedLayout

All Implemented Interfaces:

Serializable, Comparable<PredefinedLayout>
```
public enum PredefinedLayout
extends Enum<PredefinedLayout>
```
A template layout an app uses to display information. The broad details of the layout are defined, but the details depend on the IVI system. Used in SetDisplayLayout.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`DEFAULT` A default layout
`DOUBLE_GRAPHIC_WITH_SOFTBUTTONS` A layout with two graphics and soft buttons
`GRAPHIC_WITH_TEXT` A layout with a single graphic on the left and text on the right
`GRAPHIC_WITH_TEXT_AND_SOFTBUTTONS` A layout with a single graphic on the left and both text and soft buttons on the right
`GRAPHIC_WITH_TEXTBUTTONS` A layout with a single graphic on the left and text-only soft buttons on the right
`GRAPHIC_WITH_TILES` A layout with a single graphic on the left and soft buttons in a tile layout on the right
`LARGE_GRAPHIC_ONLY` A layout with only a single large graphic
`LARGE_GRAPHIC_WITH_SOFTBUTTONS` A layout with a single large graphic and soft buttons
`MEDIA` The default media layout
`NAV_FULLSCREEN_MAP` The default navigation layout with a fullscreen map
`NAV_KEYBOARD` A keyboard layout used for navigation apps
`NAV_LIST` A list layout used for navigation apps
`NON_MEDIA` The default non-media layout
`ONSCREEN_PRESETS` A media layout containing preset buttons
`TEXT_AND_SOFTBUTTONS_WITH_GRAPHIC` A layout with both text and soft buttons on the left and a single graphic on the right
`TEXT_WITH_GRAPHIC` A layout with text on the left and a single graphic on the right
`TEXTBUTTONS_ONLY` A layout with only soft buttons that only accept text
`TEXTBUTTONS_WITH_GRAPHIC` A layout with text-only soft buttons on the left and a single graphic on the right
`TILES_ONLY` A layout with only soft buttons placed in a tile layout
`TILES_WITH_GRAPHIC` A layout with soft buttons in a tile layout on the left and a single graphic on the right
`WEB_VIEW` Custom root template allowing in-vehicle WebEngine applications with appropriate permissions to show the application's own web view.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`toString()` Returns a String representing a PredefinedLayout
`static PredefinedLayout`	`valueForString(String value)` Returns a PredefinedLayout
`static PredefinedLayout`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static PredefinedLayout[]`	`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, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - DEFAULT
```
public static final PredefinedLayout DEFAULT
```
    A default layout
  - MEDIA
```
public static final PredefinedLayout MEDIA
```
    The default media layout
  - NON_MEDIA
```
public static final PredefinedLayout NON_MEDIA
```
    The default non-media layout
  - ONSCREEN_PRESETS
```
public static final PredefinedLayout ONSCREEN_PRESETS
```
    A media layout containing preset buttons
  - NAV_FULLSCREEN_MAP
```
public static final PredefinedLayout NAV_FULLSCREEN_MAP
```
    The default navigation layout with a fullscreen map
  - NAV_LIST
```
public static final PredefinedLayout NAV_LIST
```
    A list layout used for navigation apps
  - NAV_KEYBOARD
```
public static final PredefinedLayout NAV_KEYBOARD
```
    A keyboard layout used for navigation apps
  - GRAPHIC_WITH_TEXT
```
public static final PredefinedLayout GRAPHIC_WITH_TEXT
```
    A layout with a single graphic on the left and text on the right
  - TEXT_WITH_GRAPHIC
```
public static final PredefinedLayout TEXT_WITH_GRAPHIC
```
    A layout with text on the left and a single graphic on the right
  - TILES_ONLY
```
public static final PredefinedLayout TILES_ONLY
```
    A layout with only soft buttons placed in a tile layout
  - TEXTBUTTONS_ONLY
```
public static final PredefinedLayout TEXTBUTTONS_ONLY
```
    A layout with only soft buttons that only accept text
  - GRAPHIC_WITH_TILES
```
public static final PredefinedLayout GRAPHIC_WITH_TILES
```
    A layout with a single graphic on the left and soft buttons in a tile layout on the right
  - TILES_WITH_GRAPHIC
```
public static final PredefinedLayout TILES_WITH_GRAPHIC
```
    A layout with soft buttons in a tile layout on the left and a single graphic on the right
  - GRAPHIC_WITH_TEXT_AND_SOFTBUTTONS
```
public static final PredefinedLayout GRAPHIC_WITH_TEXT_AND_SOFTBUTTONS
```
    A layout with a single graphic on the left and both text and soft buttons on the right
  - TEXT_AND_SOFTBUTTONS_WITH_GRAPHIC
```
public static final PredefinedLayout TEXT_AND_SOFTBUTTONS_WITH_GRAPHIC
```
    A layout with both text and soft buttons on the left and a single graphic on the right
  - GRAPHIC_WITH_TEXTBUTTONS
```
public static final PredefinedLayout GRAPHIC_WITH_TEXTBUTTONS
```
    A layout with a single graphic on the left and text-only soft buttons on the right
  - TEXTBUTTONS_WITH_GRAPHIC
```
public static final PredefinedLayout TEXTBUTTONS_WITH_GRAPHIC
```
    A layout with text-only soft buttons on the left and a single graphic on the right
  - LARGE_GRAPHIC_WITH_SOFTBUTTONS
```
public static final PredefinedLayout LARGE_GRAPHIC_WITH_SOFTBUTTONS
```
    A layout with a single large graphic and soft buttons
  - DOUBLE_GRAPHIC_WITH_SOFTBUTTONS
```
public static final PredefinedLayout DOUBLE_GRAPHIC_WITH_SOFTBUTTONS
```
    A layout with two graphics and soft buttons
  - LARGE_GRAPHIC_ONLY
```
public static final PredefinedLayout LARGE_GRAPHIC_ONLY
```
    A layout with only a single large graphic
  - WEB_VIEW
```
public static final PredefinedLayout WEB_VIEW
```
    Custom root template allowing in-vehicle WebEngine applications with appropriate permissions to show the application's own web view.
- Method Detail
  - values
```
public static PredefinedLayout[] 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 (PredefinedLayout c : PredefinedLayout.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static PredefinedLayout 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
  - toString
```
public String toString()
```
    Returns a String representing a PredefinedLayout
    
    Overrides:
    
    toString in class Enum<PredefinedLayout>
  - valueForString
```
public static PredefinedLayout valueForString(String value)
```
    Returns a PredefinedLayout
    
    Parameters:
    
    value - a String
    
    Returns:
    
    PredefinedLayout

Enum PredefinedLayout

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

DEFAULT

MEDIA

NON_MEDIA

ONSCREEN_PRESETS

NAV_FULLSCREEN_MAP

NAV_LIST

NAV_KEYBOARD

GRAPHIC_WITH_TEXT

TEXT_WITH_GRAPHIC

TILES_ONLY

TEXTBUTTONS_ONLY

GRAPHIC_WITH_TILES

TILES_WITH_GRAPHIC

GRAPHIC_WITH_TEXT_AND_SOFTBUTTONS

TEXT_AND_SOFTBUTTONS_WITH_GRAPHIC

GRAPHIC_WITH_TEXTBUTTONS

TEXTBUTTONS_WITH_GRAPHIC

LARGE_GRAPHIC_WITH_SOFTBUTTONS

DOUBLE_GRAPHIC_WITH_SOFTBUTTONS

LARGE_GRAPHIC_ONLY

WEB_VIEW

Method Detail

values

valueOf

toString

valueForString