com.smartgwt.client.types

## Enum NavigationMethod

- java.lang.Object
- - java.lang.Enum<NavigationMethod>
  - - com.smartgwt.client.types.NavigationMethod

- All Implemented Interfaces:
    ValueEnum, java.io.Serializable, java.lang.Comparable<NavigationMethod>

      public enum NavigationMethod
      extends java.lang.Enum<NavigationMethod>
      implements ValueEnum

  Method of, or reason for, navigation between panes.

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant and Description
    `BACK_CLICK` a "back" `NavigationButton` has been clicked
    `HISTORY_CALLBACK` browser navigation triggered `SplitPane` navigation
    `NAVIGATE_PANE` application code directly called `navigatePane()`
    `PROGRAMMATIC` application code called `setCurrentPane()`, `showNavigationPane()`, `showListPane()`, `showDetailPane()`, etc.
    `SELECTION_CHANGED` a seletion change automatically called `navigatePane()`
    `SIDE_CLICK` a side panel `NavigationButton` has been clicked

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | `getValue()`
    `static NavigationMethod` | `valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
    `static NavigationMethod[]` | `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

    - #### BACK_CLICK

          public static final NavigationMethod BACK_CLICK

      a "back" `NavigationButton` has been clicked

      If this enumerated value is used in a `Component XML` file or server-side DataSource descriptor (.ds.xml file), use the value "backClick".

    - #### SIDE_CLICK

          public static final NavigationMethod SIDE_CLICK

      a side panel `NavigationButton` has been clicked

      If this enumerated value is used in a `Component XML` file or server-side DataSource descriptor (.ds.xml file), use the value "sideClick".

    - #### PROGRAMMATIC

          public static final NavigationMethod PROGRAMMATIC

      application code called `setCurrentPane()`, `showNavigationPane()`, `showListPane()`, `showDetailPane()`, etc.

      If this enumerated value is used in a `Component XML` file or server-side DataSource descriptor (.ds.xml file), use the value "programmatic".

    - #### NAVIGATE_PANE

          public static final NavigationMethod NAVIGATE_PANE

      application code directly called `navigatePane()`

      If this enumerated value is used in a `Component XML` file or server-side DataSource descriptor (.ds.xml file), use the value "navigatePane".

    - #### SELECTION_CHANGED

          public static final NavigationMethod SELECTION_CHANGED

      a seletion change automatically called `navigatePane()`

      If this enumerated value is used in a `Component XML` file or server-side DataSource descriptor (.ds.xml file), use the value "selectionChanged".

    - #### HISTORY_CALLBACK

          public static final NavigationMethod HISTORY_CALLBACK

      browser navigation triggered `SplitPane` navigation

      If this enumerated value is used in a `Component XML` file or server-side DataSource descriptor (.ds.xml file), use the value "historyCallback".

  - ### Method Detail

    - #### values

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

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

    - #### valueOf

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

    - #### getValue

          public java.lang.String getValue()

      Specified by:
        `getValue` in interface `ValueEnum`