com.hp.lft.sdk.stdwin

Interface ToolBarButton


  • public interface ToolBarButton
    A single tool bar button in a standard Windows tool bar.

    • Method Summary

      Modifier and TypeMethod and Description
      intgetIndex()
      The 0-based index number of the toolbar button.
      java.lang.StringgetName()
      Returns the name of the toolbar button.
      booleanhasEllipses()
      Indicates whether the toolbar button's text is truncated and an ellipsis (...) is displayed.
      Note: This property is not supported for QMenuBar objects.
      booleanisChecked()
      Indicates whether the toolbar button is a dual-state (toggle) push button and is currently selected (pushed).
      booleanisEnabled()
      Indicates whether the toolbar button is enabled.
      booleanisHighlighted()
      Indicates whether the toolbar button is highlighted (surrounded by a dotted line).
      booleanisHot()
      Indicates whether the toolbar button is "hot".
      booleanisIndeterminate()
      Indicates whether the toolbar button is disabled.
      booleanisMarked()
      Indicates whether the toolbar button is marked.
      booleanisPressed()
      Indicates whether the toolbar button was clicked.
      booleanisSelected()
      Indicates whether the toolbar button is currently either pressed (currently being clicked) or checked (a dual-state push button that is currently selected).
      booleanisWrap()
      Indicates whether the toolbar button is enabled and followed by a line break.
      voidpress()
      Presses the specified toolbar button.
      voidpress(MouseButton button)
      Presses the specified toolbar button.
      voidshowDropdown()
      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 an 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 an 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 an 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 an 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 an 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 an 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 an 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 an 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 an 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 an error occurs during execution.