Open topic with navigation

com.hp.lft.sdk.powerbuilder

## Interface ToolBarButton

-     public interface ToolBarButton

  A single tool bar button in a power builder tool bar.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `int` | `getIndex()` The 0-based index number of the toolbar button.
    `String` | `getName()` Returns the name of the toolbar button.
    `boolean` | `hasEllipses()` Indicates whether the toolbar button's text is truncated and an ellipsis (...) is displayed. Note: This property is not supported for QMenuBar objects.
    `boolean` | `isChecked()` Indicates whether the toolbar button is a dual-state (toggle) push button and is currently selected (pushed).
    `boolean` | `isEnabled()` Indicates whether the toolbar button is enabled.
    `boolean` | `isHighlighted()` Indicates whether the toolbar button is highlighted (surrounded by a dotted line).
    `boolean` | `isHot()` Indicates whether the toolbar button is "hot".
    `boolean` | `isIndeterminate()` Indicates whether the toolbar button is disabled.
    `boolean` | `isMarked()` Indicates whether the toolbar button is marked.
    `boolean` | `isPressed()` Indicates whether the toolbar button was clicked.
    `boolean` | `isSelected()` Indicates whether the toolbar button is currently either pressed (currently being clicked) or checked (a dual-state push button that is currently selected).
    `boolean` | `isWrap()` Indicates whether the toolbar button is enabled and followed by a line break.
    `void` | `press()` Presses the specified toolbar button.
    `void` | `press(MouseButton button)` Presses the specified toolbar button.
    `void` | `showDropdown()` Opens the drop down menu associated with this toolbar button by clicking the arrow part of the button.

- - ### Method Detail

    - #### isChecked

          boolean isChecked()
                     throws GeneralLeanFtException

      Indicates whether the toolbar button is a dual-state (toggle) push button and is currently selected (pushed).
      Returns:
        true when checked.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### hasEllipses

          boolean hasEllipses()
                       throws GeneralLeanFtException

      Indicates whether the toolbar button's text is truncated and an ellipsis (...) is displayed.
      Note: This property is not supported for QMenuBar objects.
      Returns:
        true when the toolbar button's text is truncated and an ellipsis (...) is displayed.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### isEnabled

          boolean isEnabled()
                     throws GeneralLeanFtException

      Indicates whether the toolbar button is enabled.
      Returns:
        true when enabled.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### isHighlighted

          boolean isHighlighted()
                         throws GeneralLeanFtException

      Indicates whether the toolbar button is highlighted (surrounded by a dotted line).
      Returns:
        true when highlighted.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### isHot

          boolean isHot()
                 throws GeneralLeanFtException

      Indicates whether the toolbar button is "hot". A hot toolbar button appears highlighted when the mouse pointer is over it.
      Note: This property is not supported for QMenuBar objects.
      Returns:
        true when the toolbar is "hot".
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### isIndeterminate

          boolean isIndeterminate()
                           throws GeneralLeanFtException

      Indicates whether the toolbar button is disabled.
      Returns:
        true when disabled.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### getIndex

          int getIndex()
                throws GeneralLeanFtException

      The 0-based index number of the toolbar button. The index does not include hidden and separator buttons.
      Note: This property is not supported for QMenuBar objects.
      Returns:
        the index number of the toolbar button.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### isMarked

          boolean isMarked()
                    throws GeneralLeanFtException

      Indicates whether the toolbar button is marked. The interpretation of a marked button is application dependent.
      Note: This property is not supported for QMenuBar objects.
      Returns:
        true when the toolbar button is marked.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### getName

          String getName()
                  throws GeneralLeanFtException

      Returns the name of the toolbar button.
      Returns:
        the name of the toolbar button.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### isPressed

          boolean isPressed()
                     throws GeneralLeanFtException

      Indicates whether the toolbar button was clicked.
      Returns:
        true when the toolbar button was clicked.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### isSelected

          boolean isSelected()
                      throws GeneralLeanFtException

      Indicates whether the toolbar button is currently either pressed (currently being clicked) or checked (a dual-state push button that is currently selected).
      Returns:
        true, if the toolbar button is currently either pressed or checked.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### isWrap

          boolean isWrap()
                  throws GeneralLeanFtException

      Indicates whether the toolbar button is enabled and followed by a line break.
      Returns:
        true when the toolbar button is enabled and followed by a line break.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### showDropdown

          void showDropdown()
                     throws GeneralLeanFtException

      Opens the drop down menu associated with this toolbar button by clicking the arrow part of the button.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### press

          void press(MouseButton button)
              throws GeneralLeanFtException

      Presses the specified toolbar button.
      Parameters:
        `button` - the mouse button used to press on the toolbar button. Possible values: `MouseButton`
      Throws:
        `GeneralLeanFtException` - if error occurs during execution

    - #### press

          void press()
              throws GeneralLeanFtException

      Presses the specified toolbar button.
      Throws:
        `GeneralLeanFtException` - if error occurs during execution