Open topic with navigation

com.hp.lft.sdk.wpf

## Interface ToolBarItem

-     public interface ToolBarItem

  A single tool bar button in a WPF tool bar.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `int` | `getIndex()` Returns the 1-based index number of this toolbar item.
    `java.lang.String` | `getName()` Returns the name of this toolbar item.
    `java.lang.String` | `getType()` Returns the control type of the toolbar item.
    `boolean` | `hasEllipses()` Indicates whether this toolbar item's text is truncated and an ellipsis (...) is displayed.
    `boolean` | `isChecked()` Indicates whether this toggle button is set.
    `boolean` | `isEnabled()` Indicates whether this toolbar item can accept user input.
    `boolean` | `isHot()` Indicates whether this toolbar item appears highlighted, as when the mouse hovers over it.

- - ### Method Detail

    - #### isChecked

          boolean isChecked()
                     throws GeneralLeanFtException

      Indicates whether this toggle button is set.
      Returns:
        true if checked
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### hasEllipses

          boolean hasEllipses()
                       throws GeneralLeanFtException

      Indicates whether this toolbar item's text is truncated and an ellipsis (...) is displayed.
      Returns:
        true if ellipsis displayed
      Throws:
        `GeneralLeanFtException` - if an 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 an error occurs during execution.

    - #### isHot

          boolean isHot()
                 throws GeneralLeanFtException

      Indicates whether this toolbar item appears highlighted, as when the mouse hovers over it.
      Returns:
        true if hot
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getIndex

          int getIndex()
                throws GeneralLeanFtException

      Returns the 1-based index number of this toolbar item.
      The index does not include hidden and separator buttons.
      Returns:
        the index
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getName

          java.lang.String getName()
                            throws GeneralLeanFtException

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

    - #### getType

          java.lang.String getType()
                            throws GeneralLeanFtException

      Returns the control type of the toolbar item.
      Returns:
        the control type
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.