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

All Superinterfaces:
SCCustomComponent, SCSelection
All Known Subinterfaces:
SCChoice, SCList

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 Summary
 void addItem(java.lang.String displayText)
          Adds the specified displayText to the end of the list.
 void addItem(java.lang.String displayText, java.lang.String sendText)
          Adds the specified displayText and sendText to the end of the SCSelectionList.
 void addItem(java.lang.String displayText, java.lang.String sendText, int index)
          Inserts the specified displayText and sendText at the specified index.
 void remove(int index)
          Removes the item at the specified index from the list.
 void removeAll()
          Removes all items from the list.
 void removeDisplayText(java.lang.String displayText)
          Removes the first occurrence of the displayText from the list.
 void removeItem(java.lang.String displayText, java.lang.String sendText)
          Removes the first occurence of the displayText/sendText combination from the list.
 void removeSendText(java.lang.String sendText)
          Removes the first occurrence of the sendText from the list.
 
Methods inherited from interface com.ibm.hi.customizer.beans.scci.SCSelection
getDisplayText, getDisplayText, getItemCount, getSelectedIndex, getSendText, getSendText, isIndexSelected, select, selectDisplayText, selectItem, selectSendText, setDisplayText, setItem, setSendText
 
Methods inherited from interface com.ibm.hi.customizer.beans.scci.SCCustomComponent
getBackgroundColor, getCaption, getForegroundColor, getGlobalRead, getGlobalWrite, getHelpCaption, getHostLinkLength, getHostLinkPosition, getTabNumber, hasFocus, isTempHidden, isVisible, readGlobalVariable, requestFocus, setBackgroundColor, setCaption, setForegroundColor, setGlobalRead, setGlobalWrite, setHelpCaption, setTempHidden, setVisible, toString, writeGlobalVariable
 

Method Detail

addItem

public void addItem(java.lang.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(int)

addItem

public void addItem(java.lang.String displayText,
                    java.lang.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.

addItem

public void addItem(java.lang.String displayText,
                    java.lang.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.

removeAll

public void removeAll()
Removes all items from the list.
See Also:
remove(int)

removeItem

public void removeItem(java.lang.String displayText,
                       java.lang.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.

removeDisplayText

public void removeDisplayText(java.lang.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.

removeSendText

public void removeSendText(java.lang.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

remove

public 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(java.lang.String)