Package com.hp.lft.sdk.powerbuilder

Interface ListBase<T>

Type Parameters:
T - the specified item.
All Known Subinterfaces:
ListBox, ListView
public interface ListBase<T>
Base interface for PowerBuilder list objects.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    activateItem(int itemIndex)
    Activates (double-clicks) the specified item in the list by item index.
    void
    activateItem(int itemIndex, MouseButton button)
    Activates (double-clicks) the specified item in the list by item index.
    void
    activateItem(String item)
    Activates (double-clicks) the specified item in the list by item text.
    void
    activateItem(String item, MouseButton button)
    Activates (double-clicks) the specified item in the list by item text.
    void
    activateItem(T item)
    Activates (double-clicks) the specified generic item in the list.
    void
    activateItem(T item, MouseButton button)
    Activates (double-clicks) the specified generic item in the list.
    void
    deselect(int... itemIndices)
    Deselect a list of items by items indices.
    void
    deselect(String... items)
    Deselect a list of items by items text.
    void
    deselect(T... items)
    Deselects a list of items according to a generic list.
    void
    extendSelect(int... itemIndices)
    Selects additional items from the multi-selection list.
    void
    extendSelect(String... itemNames)
    Selects additional items from the multi-selection list.
    void
    extendSelect(T... items)
    Selects additional items from the multi-selection list.
    T
    getItem(String text)
    Returns an item with the given text.
    List<T>
    getItems()
    Returns a collection of all items in the list.
    List<T>
    getSelectedItems()
    Returns all of the selected items in the list.
    void
    select(int... itemIndices)
    Selects a list of items by items indices.
    void
    select(String... items)
    Selects a list of items by items text.
    void
    select(T... items)
    Selects a list of items according to a generic list.
    void
    selectRange(int indexTo)
    Selects all list items between an already selected item and the specified item with index passed as the argument.
    void
    selectRange(int indexFrom, int indexTo)
    Selects all list items between (and including) the two specified items.
    void
    selectRange(String itemTo)
    Selects all list items between an already selected item and the specified item with text passed as the argument.

  • Method Details

    • 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 error occurs during execution

    • activateItem

      void activateItem(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 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 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 error occurs during execution

    • activateItem

      void activateItem(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 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 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 error occurs during execution

    • select

      void select(String... items) throws GeneralLeanFtException
      Selects a list of items by items text.
      Parameters:
      items - the texts of items to select from the list.
      Throws:
      GeneralLeanFtException - if 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 error occurs during execution

    • deselect

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

    • deselect

      void deselect(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 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 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 error occurs during execution

    • selectRange

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

    • selectRange

      void selectRange(String itemTo) throws GeneralLeanFtException
      Selects all list items between an already selected item and the specified item with text passed as the argument.
      This method is applicable only to lists that allow multiple selection.
      Parameters:
      itemTo - the text of the last item of the range.
      Throws:
      GeneralLeanFtException - if 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 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:
      itemIndices - the indices of the items to add to the selection.
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • extendSelect

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

    • getItem

      T getItem(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 error occurs during execution

    • getItems

      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 error occurs during execution

    • getSelectedItems

      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 error occurs during execution