Open topic with navigation

com.hp.lft.sdk.winforms

## Interface ListViewItem

- All Superinterfaces:
    SupportDragAndDrop

      public interface ListViewItem
      extends SupportDragAndDrop

  A single list item belonging to a .NET Windows Forms list-view.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `void` | `clickState()` Clicks the state image icon.
    `void` | `doubleClickState()` Double-clicks state image icon.
    `void` | `enableLabelEditing()` Activates the edit mode for the lists item label to enable renaming.
    `int` | `getState()` Returns this list-view control item's state image index.
    `java.lang.String` | `getSubItemText()` Returns the text value of this report-style (LVS_REPORT) list-view subitem.
    `java.lang.String` | `getSubItemText(int columnIndex)` Returns the text value of this report-style (LVS_REPORT) list-view subitem.
    `java.lang.String` | `getSubItemText(java.lang.String columnName)` Returns the text value of this report-style (LVS_REPORT) list-view subitem.
    `java.lang.String` | `getText()` The text of this list item.
    `boolean` | `isFocused()` Indicates whether this list item has the focus in a multiple-selection list box.
    `boolean` | `isSelected()` Indicates whether this list item is selected.
    `void` | `setItemState(int index)` Sets the state of the check box icon of the specified item in this list.

    - ### Methods inherited from interface com.hp.lft.sdk.SupportDragAndDrop

      `dragAndDropOn, dragAndDropOn`

- - ### Method Detail

    - #### getText

          java.lang.String getText()
                            throws GeneralLeanFtException

      The text of this list item. Returns an empty string if this list item does not contain any text.
      Returns:
        the text
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### isFocused

          boolean isFocused()
                     throws GeneralLeanFtException

      Indicates whether this list item has the focus in a multiple-selection list box.
      Returns:
        true if in focus
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### isSelected

          boolean isSelected()
                      throws GeneralLeanFtException

      Indicates whether this list item is selected.
      Returns:
        true if selected
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getState

          int getState()
                throws GeneralLeanFtException

      Returns this list-view control item's state image index.
      Returns:
        the image index
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getSubItemText

          java.lang.String getSubItemText(int columnIndex)
                                   throws GeneralLeanFtException

      Returns the text value of this report-style (LVS_REPORT) list-view subitem.
      Parameters:
        `columnIndex` - The 0-based index of the sub-item
      Returns:
        the text value of this report-style (LVS_REPORT) list-view subitem
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getSubItemText

          java.lang.String getSubItemText()
                                   throws GeneralLeanFtException

      Returns the text value of this report-style (LVS_REPORT) list-view subitem.
      Returns:
        the text value of this specified report-style (LVS_REPORT) list-view subitem
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getSubItemText

          java.lang.String getSubItemText(java.lang.String columnName)
                                   throws GeneralLeanFtException

      Returns the text value of this report-style (LVS_REPORT) list-view subitem.
      Parameters:
        `columnName` - The name of the sub-item
      Returns:
        the text value of the report-style (LVS_REPORT) list-view subitem.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### setItemState

          void setItemState(int index)
                     throws GeneralLeanFtException

      Sets the state of the check box icon of the specified item in this list.
      Parameters:
        `index` - the 0-based state image index
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### clickState

          void clickState()
                   throws GeneralLeanFtException

      Clicks the state image icon.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### doubleClickState

          void doubleClickState()
                         throws GeneralLeanFtException

      Double-clicks state image icon.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### enableLabelEditing

          void enableLabelEditing()
                           throws GeneralLeanFtException

      Activates the edit mode for the lists item label to enable renaming. After enabling with this method, to rename the item, use the `EditField` or `Editor` test object, together with an applicable method.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.