Interface MenuItemBase

All Known Subinterfaces:
MenuItem, MenuItem

public interface MenuItemBase
Base interface for all MenuItem interfaces in SDK.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Indicates whether the menu item exists.
    int
    Returns the 0-based numeric index location of the menu item.
    Returns the menu item label.
    Returns the path of the menu item.
    int
    The number of items contained in the specified menu item's sub-menu.
    boolean
    Indicates whether the menu item has a sub-menu.
    boolean
    Indicates whether the menu item has a check mark displayed next to it.
    boolean
    Indicates whether the menu item is enabled.
  • Method Details

    • getPath

      String getPath() throws GeneralLeanFtException
      Returns the path of the menu item. Menu items are separated with ; character.
      Returns:
      the path of the menu item.
      Throws:
      GeneralLeanFtException - if error occurs during execution
    • isChecked

      boolean isChecked() throws GeneralLeanFtException
      Indicates whether the menu item has a check mark displayed next to it.
      Returns:
      true, if the menu item has a check mark displayed next to it.
      Throws:
      GeneralLeanFtException - if error occurs during execution
    • isEnabled

      boolean isEnabled() throws GeneralLeanFtException
      Indicates whether the menu item is enabled.
      Returns:
      true, if the menu item is enabled.
      Throws:
      GeneralLeanFtException - if error occurs during execution
    • exists

      boolean exists() throws GeneralLeanFtException
      Indicates whether the menu item exists.
      Returns:
      true, if the menu item exists.
      Throws:
      GeneralLeanFtException - if error occurs during execution
    • hasSubMenu

      boolean hasSubMenu() throws GeneralLeanFtException
      Indicates whether the menu item has a sub-menu.
      Returns:
      true if the menu item has a sub-menu.
      Throws:
      GeneralLeanFtException - if error occurs during execution
    • getIndex

      int getIndex() throws GeneralLeanFtException
      Returns the 0-based numeric index location of the menu item.
      Returns:
      the 0-based numeric index location of the menu item.
      Throws:
      GeneralLeanFtException - if error occurs during execution
    • getLabel

      String getLabel() throws GeneralLeanFtException
      Returns the menu item label.
      Returns:
      the menu item label.
      Throws:
      GeneralLeanFtException - if error occurs during execution
    • getSubMenuCount

      int getSubMenuCount() throws GeneralLeanFtException
      The number of items contained in the specified menu item's sub-menu.
      Returns:
      the number of items contained in the specified menu item's sub-menu.
      Throws:
      GeneralLeanFtException - if error occurs during execution