com.hp.lft.sdk.stdwin

Interface ListViewItem

All Superinterfaces:

SupportDragAndDrop

public interface ListViewItem
extends SupportDragAndDrop

A single list item in a standard Windows list-view object.

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 the list item's state image index.
java.lang.String	getSubItemText() Returns the text value of the specified report-style (LVS_REPORT) list-view subitem.
java.lang.String	getSubItemText(int columnIndex) Returns the text value of the specified report-style (LVS_REPORT) list-view subitem.
java.lang.String	getSubItemText(java.lang.String columnName) Returns the text value of the specified report-style (LVS_REPORT) list-view subitem.
java.lang.String	getText() Returns the text value of the list item, or "" when empty.
boolean	isFocused() Indicates whether the list item is in focus in a multiple selection list box.
boolean	isSelected() Indicates whether the list item is selected.
void	setItemState(int index) Sets the state of the check box icon of the specified item in the list.

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

dragAndDropOn, dragAndDropOn

Method Detail

getText

java.lang.String getText()
                  throws GeneralLeanFtException

Returns the text value of the list item, or "" when empty.

Returns:

text value of the list item.

Throws:

GeneralLeanFtException - if error occurs during execution

isFocused

boolean isFocused()
           throws GeneralLeanFtException

Indicates whether the list item is in focus in a multiple selection list box.

Returns:

true, if the list item is in focus in a multiple selection list box.

Throws:

GeneralLeanFtException - if error occurs during execution

isSelected

boolean isSelected()
            throws GeneralLeanFtException

Indicates whether the list item is selected.

Returns:

true when the list item is selected.

Throws:

GeneralLeanFtException - if error occurs during execution

getState

int getState()
      throws GeneralLeanFtException

Returns the list item's state image index.

Returns:

the list item's state image index.

Throws:

GeneralLeanFtException - if error occurs during execution

getSubItemText

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

Returns the text value of the specified report-style (LVS_REPORT) list-view subitem.

Parameters:

columnIndex - The 0-based numeric index of the list-view subitem you want to retrieve.

Returns:

the text value of the specified report-style (LVS_REPORT) list-view subitem.

Throws:

GeneralLeanFtException - if error occurs during execution

getSubItemText

java.lang.String getSubItemText()
                         throws GeneralLeanFtException

Returns the text value of the specified report-style (LVS_REPORT) list-view subitem.

Returns:

the text value of the specified report-style (LVS_REPORT) list-view subitem.

Throws:

GeneralLeanFtException - if error occurs during execution

getSubItemText

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

Returns the text value of the specified report-style (LVS_REPORT) list-view subitem.

Parameters:

columnName - the name of the list-view subitem you want to retrieve.

Returns:

the text value of the specified report-style (LVS_REPORT) list-view subitem.

Throws:

GeneralLeanFtException - if error occurs during execution

setItemState

void setItemState(int index)
           throws GeneralLeanFtException

Sets the state of the check box icon of the specified item in the list.

Parameters:

index - the 0-based state image index.

Throws:

GeneralLeanFtException - if error occurs during execution

clickState

void clickState()
         throws GeneralLeanFtException

Clicks the state image icon.

Throws:

GeneralLeanFtException - if error occurs during execution

doubleClickState

void doubleClickState()
               throws GeneralLeanFtException

Double-clicks state image icon.

Throws:

GeneralLeanFtException - if error occurs during execution

enableLabelEditing

void enableLabelEditing()
                 throws GeneralLeanFtException

Activates the edit mode for the lists item label to enable renaming.
IMPORTANT: This method only enables the item for renaming. To actually rename the item, you must set its value using the EditField or Editor test object, together with an applicable method.

Throws:

GeneralLeanFtException - if error occurs during execution