All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.ibm.hi.customizer.beans.scci.SCSelectionList

public interface SCSelectionList
extends SCSelection
SCSelectionList is the parent interface to SCList and SCChoice, both of which may add and delete items from their respective lists.

See Also:
SCChoice, SCList

Method Index

 o addItem(String)
Adds the specified displayText to the end of the list.
 o addItem(String, String)
Adds the specified displayText and sendText to the end of the SCSelectionList.
 o addItem(String, String, int)
Inserts the specified displayText and sendText at the specified index.
 o remove(int)
Removes the item at the specified index from the list.
 o removeAll()
Removes all items from the list.
 o removeDisplayText(String)
Removes the first occurrence of the displayText from the list.
 o removeItem(String, String)
Removes the first occurence of the displayText/sendText combination from the list.
 o removeSendText(String)
Removes the first occurrence of the sendText from the list.

Methods

 o addItem
 public abstract void addItem(String displayText)
Adds the specified displayText to the end of the list. The sendText is defaulted to be the same as the displayText.

Parameters:
displayText - the displayText to add.
See Also:
remove
 o addItem
 public abstract void addItem(String displayText,
                              String sendText)
Adds the specified displayText and sendText to the end of the SCSelectionList.

Parameters:
displayText - the displayText to add.
sendText - the sendText to add.
 o addItem
 public abstract void addItem(String displayText,
                              String sendText,
                              int index)
Inserts the specified displayText and sendText at the specified index. The index is zero-based. If value of the index is -1, the item is added at the end. If value of the index is greater than the number of items in the list, the item is added at the end.

Parameters:
displayText - the displayText to add.
sendText - the sendText to add.
index - the index at which to insert the item.
 o removeAll
 public abstract void removeAll()
Removes all items from the list.

See Also:
remove
 o removeItem
 public abstract void removeItem(String displayText,
                                 String sendText)
Removes the first occurence of the displayText/sendText combination from the list. If the displayText/sendText combination is not found, the operation is ignored.

Parameters:
displayText - the displayText to remove.
sendText - the sendText to remove.
 o removeDisplayText
 public abstract void removeDisplayText(String displayText)
Removes the first occurrence of the displayText from the list. If the displayText is not found, the operation is ignored.

Parameters:
displayText - the displayText to remove.
 o removeSendText
 public abstract void removeSendText(String sendText)
Removes the first occurrence of the sendText from the list. If the sendText is not found, the operation is ignored.

Parameters:
sendText - the sendText to remove
 o remove
 public abstract void remove(int index)
Removes the item at the specified index from the list.

Parameters:
index - the index of the item to delete.
See Also:
addItem

All Packages  Class Hierarchy  This Package  Previous  Next  Index