com.hp.lft.sdk.stdwin

Interface ListBase<T>

  • Type Parameters:
    T - the specified item.
    All Known Subinterfaces:
    ListBox, ListView

    public interface ListBase<T>
    Base interface for standard Windows list objects.

    • Method Summary

      Modifier and TypeMethod and Description
      voidactivateItem(int itemIndex)
      Activates (double-clicks) the specified item in the list by item index.
      voidactivateItem(int itemIndex, MouseButton button)
      Activates (double-clicks) the specified item in the list by item index.
      voidactivateItem(java.lang.String item)
      Activates (double-clicks) the specified item in the list by item text.
      voidactivateItem(java.lang.String item, MouseButton button)
      Activates (double-clicks) the specified item in the list by item text.
      voidactivateItem(T item)
      Activates (double-clicks) the specified generic item in the list.
      voidactivateItem(T item, MouseButton button)
      Activates (double-clicks) the specified generic item in the list.
      voiddeselect(int... itemIndices)
      Deselect a list of items by items indices.
      voiddeselect(java.lang.String... items)
      Deselect a list of items by items text.
      voiddeselect(T... items)
      Deselects a list of items according to a generic list.
      voidextendSelect(int... itemIndices)

      Selects additional items from the multi-selection list.

      voidextendSelect(java.lang.String... itemNames)

      Selects additional items from the multi-selection list.

      voidextendSelect(T... items)

      Selects additional items from the multi-selection list.

      TgetItem(java.lang.String text)
      Returns an item with the given text.
      java.util.List<T>getItems()
      Returns a collection of all items in the list.
      java.util.List<T>getSelectedItems()
      Returns all of the selected items in the list.
      voidselect(int... itemIndices)
      Selects a list of items by items indices.
      voidselect(java.lang.String... items)
      Selects a list of items by items text.
      voidselect(T... items)
      Selects a list of items according to a generic list.
      voidselectRange(int indexTo) Selects all list items between the currently selected item and the item whose index is specified.
      voidselectRange(int indexFrom, int indexTo)
      Selects all list items between (and including) the two specified items.
      voidselectRange(java.lang.String itemTo) Selects all list items between the currently selected item and the item whose text is specified.
      voidselectRange(java.lang.String itemFrom, java.lang.String itemTo)
      Selects all list items between (and including) the two specified items.
      voidselectRange(T itemTo) Selects all list items between the currently selected item and the item passed as the argument.
      voidselectRange(T itemFrom, T itemTo) Selects all list items between (and including) the two specified items.

    • Method Detail

      • activateItem

        void activateItem(T item,
                  MouseButton button)
           throws GeneralLeanFtException
        Activates (double-clicks) the specified generic item in the list.
        Parameters:
        item - the specified item to activate from the list.
        button - the mouse button used to select the list item. Possible values: see MouseButton.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • activateItem

        void activateItem(java.lang.String item,
                  MouseButton button)
           throws GeneralLeanFtException
        Activates (double-clicks) the specified item in the list by item text.
        Parameters:
        item - the specified item to activate from the list.
        button - the mouse button used to select the list item. Possible values: see MouseButton
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • activateItem

        void activateItem(int itemIndex,
                  MouseButton button)
           throws GeneralLeanFtException
        Activates (double-clicks) the specified item in the list by item index.
        Parameters:
        itemIndex - the item index to activate.
        button - the mouse button used to select the list item. Possible values: see MouseButton
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • activateItem

        void activateItem(T item)
           throws GeneralLeanFtException
        Activates (double-clicks) the specified generic item in the list.
        Parameters:
        item - the specified item to activate from the list.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • activateItem

        void activateItem(java.lang.String item)
           throws GeneralLeanFtException
        Activates (double-clicks) the specified item in the list by item text.
        Parameters:
        item - the specified item to activate from the list.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • activateItem

        void activateItem(int itemIndex)
           throws GeneralLeanFtException
        Activates (double-clicks) the specified item in the list by item index.
        Parameters:
        itemIndex - the item index to activate.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • select

        void select(T... items)
     throws GeneralLeanFtException
        Selects a list of items according to a generic list.
        Parameters:
        items - the items to select from the list.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • select

        void select(java.lang.String... items)
     throws GeneralLeanFtException
        Selects a list of items by items text.
        Parameters:
        items - the texts of the items to select from the list.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • select

        void select(int... itemIndices)
     throws GeneralLeanFtException
        Selects a list of items by items indices.
        Parameters:
        itemIndices - the item indices to select.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • deselect

        void deselect(T... items)
       throws GeneralLeanFtException
        Deselects a list of items according to a generic list.
        Parameters:
        items - the items to deselect from the list.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • deselect

        void deselect(java.lang.String... items)
       throws GeneralLeanFtException
        Deselect a list of items by items text.
        Parameters:
        items - the texts of the items to deselect from the list.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • deselect

        void deselect(int... itemIndices)
       throws GeneralLeanFtException
        Deselect a list of items by items indices.
        Parameters:
        itemIndices - the item indices to deselect.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • selectRange

        void selectRange(int indexFrom,
                 int indexTo)
          throws GeneralLeanFtException
        Selects all list items between (and including) the two specified items.
        Parameters:
        indexFrom - the 0-based index of the first item in the range.
        indexTo - the 0-based index of the last item of the range.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • selectRange

        void selectRange(int indexTo)
		throws GeneralLeanFtException
        Selects all list items between the currently selected item and the item whose index is specified.
        This method is applicable only to lists that allow multiple selection.
        Parameters:
        indexTo - the 0-based index of the last item to select.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • selectRange

        void selectRange(java.lang.String itemTo)
		throws GeneralLeanFtException
        Selects all list items between the currently selected item and the item whose text is specified.
        This method is applicable only to lists that allow multiple selection.
        Parameters:
        indexTo - the text of the last item to select.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • selectRange

        void selectRange(java.lang.String itemFrom, java.lang.String itemTo)
			throws GeneralLeanFtException
        Selects all list items between (and including) the two specified items.
        This method is applicable only to lists that allow multiple selection.
        Parameters:
        itemFrom - the text of the first item in the range.
        itemTo - the text of the last item in the range.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • selectRange

        void selectRange(T itemTo)
		throws GeneralLeanFtException
        Selects all list items between the currently selected item and the item passed as the argument.
        This method is applicable only to lists that allow multiple selection.
        Parameters:
        itemTo - the last item to select.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • selectRange

        void selectRange(T itemFrom, T itemTo)
	throws GeneralLeanFtException
        Selects all list items between (and including) the two specified items.
        This method is applicable only to lists that allow multiple selection.
        Parameters:
        itemFrom - the first item in the range.
        itemTo - the last item of the range.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • extendSelect

        void extendSelect(int... itemIndices)
        throws GeneralLeanFtException
        Selects additional items from the multi-selection list. This method is applicable only to lists that allow multiple selection.
        Parameters:
        items - the indices of the items to add to the selection.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • extendSelect

        void extendSelect(java.lang.String... items)
	throws GeneralLeanFtException
        Selects additional items from the multi-selection list. This method is applicable only to lists that allow multiple selection.
        Parameters:
        items - the names of the items to add to the selection.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • extendSelect

        void extendSelect(T... items)
	throws GeneralLeanFtException
        Selects additional items from the multi-selection list. This method is applicable only to lists that allow multiple selection.
        Parameters:
        items - the items to add to the selection.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • getItem

                                                    T getItem(java.lang.String text)
   throws GeneralLeanFtException
        Returns an item with the given text.
        Parameters:
        text - the text of the specified item.
        Returns:
        an item with the given text.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • getItems

        java.util.List<T> getItems()
                    throws GeneralLeanFtException
        Returns a collection of all items in the list.
        Returns:
        a collection of all items in the list.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.

      • getSelectedItems

        java.util.List<T> getSelectedItems()
                            throws GeneralLeanFtException
        Returns all of the selected items in the list.
        Returns:
        all of the selected items in the list.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.