Open topic with navigation

com.hp.lft.sdk.oracle

# Interface UiFormBase

Note: Supported in LeanFT versions 14.52 and later.

- All Superinterfaces:
    Clickable, LocationInfoProvider, UiObjectBase
  All Known Subinterfaces:
    FormWindow

      public interface UiFormBase
      extends UiObjectBase

  Base interface of all Oracle windows test objects.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `activate()` Activates the form.
    `String` | `buildMenuPath(String... menuPathParts)` Returns the path constructed from the path parts.
    `void` | `closeForm()` Closes the form using the Exit softkey
    `void` | `closeWindow()` Closes the form using the X button in the form window title bar.
    `MenuItem` | `getItem(String itemPath)` Returns the item at the specified path.
    `String` | `getTitle()` Returns the window title.
    `void` | `pressToolbarButton(String buttonName)` Presses a toolbar button.
    `void` | `save()` Performs a Save operation using the Commit softkey.
    `void` | `selectMenuItem(MenuItem item)` Selects a menu option.
    `void` | `selectMenuItem(String itemPath)` Selects a menu option.

    - ### Methods inherited from interface com.hp.lft.sdk.oracle.UiObjectBase

      `getObjectType, sendKey`

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

      `click, click, click`

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

      `getAbsoluteLocation, getLocation, getSize`

- - ### Method Detail

    - #### getTitle

          String getTitle()
                   throws GeneralLeanFtException

      Returns the window title.
      Returns:
        the general object type.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### activate

          void activate()
                 throws GeneralLeanFtException

      Activates the form.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### closeForm

          void closeForm()
                  throws GeneralLeanFtException

      Closes the form using the Exit softkey
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### closeWindow

          void closeWindow()
                    throws GeneralLeanFtException

      Closes the form using the X button in the form window title bar.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### pressToolbarButton

          void pressToolbarButton(String buttonName)
                           throws GeneralLeanFtException

      Presses a toolbar button.
      Parameters:
        `buttonName` - The button name.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### save

          void save()
             throws GeneralLeanFtException

      Performs a Save operation using the Commit softkey.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### buildMenuPath

          String buildMenuPath(String... menuPathParts)

      Returns the path constructed from the path parts.
      Parameters:
        `menuPathParts` - the menu path parts must be strings. If a string is a full path, separate its items with "->" characters.
      Returns:

      The path constructed from the path parts.

    - #### selectMenuItem

          void selectMenuItem(MenuItem item)
                       throws GeneralLeanFtException

      Selects a menu option. You can use `getItem(String)` to get the item to use as the item argument.
      Parameters:
        `item` - item to select
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### selectMenuItem

          void selectMenuItem(String itemPath)
                       throws GeneralLeanFtException

      Selects a menu option. You can use `buildMenuPath(String...)` to build the itemPath argument.
      Parameters:
        `itemPath` - the path of the item to select.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### getItem

          MenuItem getItem(String itemPath)
                    throws GeneralLeanFtException

      Returns the item at the specified path.
      Parameters:
        `itemPath` - the full path of the menu item to select from the list. The path is composed of the menu item names separated by '`->`' characters.
      Returns:
        MenuItem representing the menu item.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution