Open topic with navigation

com.hp.lft.sdk.sap.gui

## Class TreeViewDescription

- java.lang.Object
- - com.hp.lft.sdk.internal.PropertiesDescriptionBase
  - - com.hp.lft.sdk.PropertiesDescription
    - - com.hp.lft.sdk.DescriptionBase
      - - com.hp.lft.sdk.sap.gui.ElementDescription
        - - com.hp.lft.sdk.sap.gui.TreeViewDescription

- All Implemented Interfaces:
    CloneableObject, Description, com.hp.lft.sdk.internal.DescriptionWithVri, java.lang.Cloneable

      public class TreeViewDescription
      extends ElementDescription

  Description of a SAP GUI for Windows tree.

- - ### Nested Class Summary

    Modifier and Type | Class and Description
    --- | ---
    `static class` | `TreeViewDescription.Builder` This class can be used to construct an instance of the TreeDescription class using the builder pattern.
    `protected static class` | `TreeViewDescription.Init<T extends TreeViewDescription.Init<T>>` Helper class for TreeDescription.Builder.

  - ### Field Summary

    - ### Fields inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase

      `properties`

  - ### Constructor Summary

    Modifier | Constructor and Description
    --- | ---
    `` | `TreeViewDescription()` Initializes a new instance of the TreeDescription class.
    `protected` | `TreeViewDescription(TreeViewDescription.Init<?> init)` Initializes a new instance of the TreeDescription class using the Builder pattern.

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `StringProperty` | `getSelectedItem()` Returns the selected item.
    `StringProperty` | `getSelectedNodePath()` Returns the path of the selected node in the tree.
    `TreeSelectionMode` | `getSelectionMode()` Returns which selections can be made.
    `TreeType` | `getTreeType()` Returns the type of the tree.
    `java.lang.Boolean` | `isEnabled()` Indicates whether the the tree view can accept user input.
    `void` | `setEnabled(java.lang.Boolean isEnabled)` Sets whether the the tree view can accept user input.
    `void` | `setSelectedItem(java.lang.String item)` Sets the selected item in the tree.
    `void` | `setSelectedItem(StringProperty item)` Sets the selected item in the tree.
    `void` | `setSelectedNodePath(java.lang.String nodePath)` Sets the path of the selected node in the tree.
    `void` | `setSelectedNodePath(StringProperty nodePath)` Sets the path of the selected node in the tree.
    `void` | `setSelectionMode(TreeSelectionMode mode)` Sets which selections can be made.
    `void` | `setTreeType(TreeType type)` Sets the type of the tree.

    - ### Methods inherited from class com.hp.lft.sdk.sap.gui.ElementDescription

      `getAbsoluteLocation, getId, getLocation, getName, getSize, getType, setAbsoluteLocation, setAbsoluteLocation, setAbsoluteLocation, setId, setId, setLocation, setLocation, setLocation, setName, setName, setSize, setSize, setSize, setType`

    - ### Methods inherited from class com.hp.lft.sdk.DescriptionBase

      `cloneTo, getIndex, getIndexType, getVRI, setIndex, setIndexType, setVRI, setVRI`

    - ### Methods inherited from class com.hp.lft.sdk.PropertiesDescription

      `clone`

    - ### Methods inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase

      `getValueAs, getValueAsStringProperty, insertValue`

    - ### Methods inherited from class java.lang.Object

      `equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

    - ### Methods inherited from interface com.hp.lft.sdk.CloneableObject

      `clone`

- - ### Constructor Detail

    - #### TreeViewDescription

          public TreeViewDescription()

      Initializes a new instance of the TreeDescription class.

    - #### TreeViewDescription

          protected TreeViewDescription(TreeViewDescription.Init<?> init)

      Initializes a new instance of the TreeDescription class using the Builder pattern.
      Parameters:
        `init` - the Builder pattern.

  - ### Method Detail

    - #### setSelectedItem

          public void setSelectedItem(java.lang.String item)

      Sets the selected item in the tree.
      Parameters:
        `item` - the item.

    - #### setSelectedItem

          public void setSelectedItem(StringProperty item)

      Sets the selected item in the tree.
      Parameters:
        `item` - a `StringProperty` or `RegExpProperty`.

    - #### getSelectedItem

          public StringProperty getSelectedItem()

      Returns the selected item.
      Returns:
        the selected item.

    - #### setSelectedNodePath

          public void setSelectedNodePath(java.lang.String nodePath)

      Sets the path of the selected node in the tree.
      Parameters:
        `nodePath` - the node path.

    - #### setSelectedNodePath

          public void setSelectedNodePath(StringProperty nodePath)

      Sets the path of the selected node in the tree.
      Parameters:
        `nodePath` - a `StringProperty` or `RegExpProperty` represents the path of the selected node.

    - #### getSelectedNodePath

          public StringProperty getSelectedNodePath()

      Returns the path of the selected node in the tree.
      Returns:
        the selected node.

    - #### setTreeType

          public void setTreeType(TreeType type)

      Sets the type of the tree.
      Parameters:
        `type` - the type.

    - #### getTreeType

          public TreeType getTreeType()

      Returns the type of the tree.
      Returns:
        the type.

    - #### setSelectionMode

          public void setSelectionMode(TreeSelectionMode mode)

      Sets which selections can be made.
      Parameters:
        `mode` - the selection mode.

    - #### getSelectionMode

          public TreeSelectionMode getSelectionMode()

      Returns which selections can be made.
      Returns:
        the selection mode of the tree.

    - #### setEnabled

          public void setEnabled(java.lang.Boolean isEnabled)

      Sets whether the the tree view can accept user input.
      Parameters:
        `isEnabled` - true to set as enabled.

    - #### isEnabled

          public java.lang.Boolean isEnabled()

      Indicates whether the the tree view can accept user input.
      Returns:
        true if enabled.