com.hp.lft.sdk.java

Interface List

    • Method Detail

      • activateItem

        void activateItem(java.lang.String item)
                   throws GeneralLeanFtException
        Activates an item in the list.
        Parameters:
        item - the name of the item to activate.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.
      • activateItem

        void activateItem(int itemIndex)
                   throws GeneralLeanFtException
        Activates an item in the list.
        Parameters:
        itemIndex - the 0-based index of the item to activate.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.
      • deselect

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

        void deselect(int... itemIndices)
               throws GeneralLeanFtException
        Deselects items from the list.
        Parameters:
        itemIndices - 0-based indices of the items to deselect.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.
      • select

        void select(java.lang.String... items)
             throws GeneralLeanFtException
        Selects multiple items by string values.
        Parameters:
        items - string values of the items to select.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.
      • select

        void select(int... itemIndices)
             throws GeneralLeanFtException
        Selects multiple items by indices.
        Parameters:
        itemIndices - the 0-based indices of the items to select.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.
      • selectRange

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

        void selectRange(ListItem itemFrom,
        		  ListItem itemTo)
                  throws GeneralLeanFtException
        Selects list items between (and including) the two specified items.
        Note: Supported from LeanFT 14.51.
        Parameters:
        indexFrom - the first item to select.
        indexTo - the last item to select.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.
      • selectRange

        void selectRange(java.lang.String itemNameFirst,
        		java.lang.String itemNameLast)
        	throws GeneralLeanFtException
        Selects list items between (and including) the two specified items, by names.
        Parameters:
        itemNameFirst - the name of the first item.
        itemNameLast - the name of the last item.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.
      • deselectRange

        void deselectRange(int indexFrom,
                           int indexTo)
                    throws GeneralLeanFtException
        Deselects list items between (and including) the two specified items.
        Parameters:
        indexFrom - 0-based index of the first item.
        indexTo - 0-based index of the last item.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.
      • getSelectedItems

        java.util.List<ListItem> getSelectedItems()
                                           throws GeneralLeanFtException
        Returns the list of items that are selected in the list object.
        Returns:
        the texts of the selected items.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.
      • extendSelect

        void extendSelect(int... itemIndices)
        		throws GeneralLeanFtException
        Selects additional items from the multi-selection list, by index.
        Note: Supported from LeanFT 14.51.
        Parameters:
        items - the indices of the items to add to the selection.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.
      • extendSelect

        void extendSelect(ListItem... items)
        		throws GeneralLeanFtException
        Selects additional items from the multi-selection list, by ListItem.
        Note: Supported from LeanFT 14.51.
        Parameters:
        items - 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, by name.
        Parameters:
        items - The names of the items to add to the selection.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.
      • getItem

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