Package com.hp.lft.sdk.winforms

Interface ToolBarItem

public interface ToolBarItem
A single tool bar item belonging to a .NET Windows Forms tool bar.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getIndex()
    Returns the 0-based index of this toolbar item.
    String
    getName()
    Returns the name of this toolbar item.
    boolean
    hasEllipses()
    Indicates whether the toolbar item's text is truncated and an ellipsis (...) is displayed.
    This property is not supported for QMenuBar objects.
    boolean
    isChecked()
    Indicates whether a toggle push button is currently set.
    Only invoke on dual-state (toggle) push buttons.
    boolean
    isEnabled()
    Indicates whether this toolbar item can accept user input.
    boolean
    isHidden()
    Indicates whether this item is not visible and therefore cannot accept user input.
    An item can be visible and disabled for other reasons.
    boolean
    isHighlighted()
    Indicates whether this toolbar item is surrounded by a dotted line.
    boolean
    isHot()
    Indicates whether this toolbar item appears highlighted, as when the mouse hovers over it.
    This property is not supported for QMenuBar objects.
    boolean
    isIndeterminate()
    Indicates that this control is neither checked nor unchecked.
    boolean
    isMarked()
    Indicates whether this toolbar item is marked.
    boolean
    isPressed()
    Indicates whether the toolbar item is currently being clicked.
    boolean
    isWrap()
    Indicates whether this toolbar item is followed by a line break.
    Only invoke if the item is enabled.
    void
    press()
    Presses this toolbar item.

  • Method Details

    • isHidden

      boolean isHidden() throws GeneralLeanFtException
      Indicates whether this item is not visible and therefore cannot accept user input.
      An item can be visible and disabled for other reasons. See isEnabled()
      Returns:
      true if not visible
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • isChecked

      boolean isChecked() throws GeneralLeanFtException
      Indicates whether a toggle push button is currently set.
      Only invoke on dual-state (toggle) push buttons.
      Returns:
      true, if the toolbar is checked.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • hasEllipses

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

    • isEnabled

      boolean isEnabled() throws GeneralLeanFtException
      Indicates whether this toolbar item can accept user input.
      Returns:
      true if enabled
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • isHighlighted

      boolean isHighlighted() throws GeneralLeanFtException
      Indicates whether this toolbar item is surrounded by a dotted line.
      Returns:
      true if highlighted
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • isHot

      boolean isHot() throws GeneralLeanFtException
      Indicates whether this toolbar item appears highlighted, as when the mouse hovers over it.
      This property is not supported for QMenuBar objects.
      Returns:
      true if toolbar hot
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • isIndeterminate

      boolean isIndeterminate() throws GeneralLeanFtException
      Indicates that this control is neither checked nor unchecked. An indeterminate control generally has a shaded appearance.
      Returns:
      true if indeterminate
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • getIndex

      int getIndex() throws GeneralLeanFtException
      Returns the 0-based index of this toolbar item. The index does not include hidden and separator buttons.
      This property is not supported for QMenuBar objects.
      Returns:
      the index
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • isMarked

      boolean isMarked() throws GeneralLeanFtException
      Indicates whether this toolbar item is marked. The interpretation of a marked button is application dependent.
      This property is not supported for QMenuBar objects.
      Returns:
      true if marked
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • getName

      String getName() throws GeneralLeanFtException
      Returns the name of this toolbar item.
      Returns:
      the name
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • isPressed

      boolean isPressed() throws GeneralLeanFtException
      Indicates whether the toolbar item is currently being clicked.
      Returns:
      true if being clicked
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • isWrap

      boolean isWrap() throws GeneralLeanFtException
      Indicates whether this toolbar item is followed by a line break.
      Only invoke if the item is enabled.
      Returns:
      true if followed by line break
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • press

      void press() throws GeneralLeanFtException
      Presses this toolbar item.
      Throws:
      GeneralLeanFtException - if error occurs during execution