All Packages Class Hierarchy This Package Previous Next Index
Interface com.ibm.hi.customizer.beans.scci.SCSelection
- public interface SCSelection
- extends SCCustomComponent
SCSelection is the parent interface of the "selection" components:
SCRadioButton, SCChoice, and SCList. Each of these
components has a list of possible choices (of which one
may be selected at a time) and a value sent to the host. Each item
in the selection has two properties associated with it:
the "displayText", which is what will be displayed to the
user, and the "sendText", which is the String sent to
the host upon selection.
- See Also:
- SCSelectionList, SCRadioButton
-
getDisplayText()
- Get the selected displayText from the list.
-
getDisplayText(int)
- Gets the displayText at the specified index.
-
getItemCount()
- Gets the number of items in the list.
-
getSelectedIndex()
- Gets the index of the selected item.
-
getSendText()
- Gets the selected sendText from the list.
-
getSendText(int)
- Gets the sendText at the specified index.
-
isIndexSelected(int)
- Checks whether an index is selected.
-
select(int)
- Selects the item at the specified index.
-
selectDisplayText(String)
- Selects the first occurrence of the specified displayText in the list.
-
selectItem(String, String)
- Selects the first occurrence of the specified displayText/sendText combination in the list.
-
selectSendText(String)
- Selects the first occurrence of the specified sendText in the list.
-
setDisplayText(String, int)
- Replaces the displayText at the specified index.
-
setItem(String, String, int)
- Replaces the displayText and sendText at the specified index.
-
setSendText(String, int)
- Replaces the sendText at the specified index.
getItemCount
public abstract int getItemCount()
- Gets the number of items in the list.
- Returns:
- the number of items in the list.
getDisplayText
public abstract String getDisplayText(int index)
- Gets the displayText at the specified index.
- Parameters:
-
index
- the index of the list.
- Returns:
- the displayText at the specified index.
- See Also:
- getItemCount, getSendText
getSendText
public abstract String getSendText(int index)
- Gets the sendText at the specified index.
- Parameters:
-
index
- the index of the list.
- Returns:
- the sendText at the specified index.
- See Also:
- getItemCount, getDisplayText
setItem
public abstract void setItem(String displayText,
String sendText,
int index)
- Replaces the displayText and sendText at the specified index.
- Parameters:
-
displayText
- the new displayText.
-
sendText
- the new sendText.
-
index
- the index to replace.
setDisplayText
public abstract void setDisplayText(String displayText,
int index)
- Replaces the displayText at the specified index.
- Parameters:
-
displayText
- the new displayText.
-
index
- the index to replace.
setSendText
public abstract void setSendText(String sendText,
int index)
- Replaces the sendText at the specified index.
- Parameters:
-
sendText
- the new sendText.
-
index
- the index to replace.
getSelectedIndex
public abstract int getSelectedIndex()
- Gets the index of the selected item.
- Returns:
- the index of the selected item, or
-1
if no item is selected.
- See Also:
- select, isIndexSelected
getDisplayText
public abstract String getDisplayText()
- Get the selected displayText from the list.
- Returns:
- the selected displayText from the list, or
an empty string if there is none, or
null
if no item is selected.
- See Also:
- select, isIndexSelected
getSendText
public abstract String getSendText()
- Gets the selected sendText from the list.
- Returns:
- the selected sendText from the list, or
an empty string if there is none, or
null
if no item is selected
- See Also:
- select, isIndexSelected
select
public abstract void select(int index)
- Selects the item at the specified index.
If another index is selected, it will be deselected.
If the index is out of range, the operation is ignored.
If the index is already selected, the operation is ignored.
- Parameters:
-
index
- the index to select.
- See Also:
- getDisplayText, isIndexSelected
selectItem
public abstract void selectItem(String displayText,
String sendText)
- Selects the first occurrence of the specified displayText/sendText combination in the list.
If another index is selected, it will be deselected.
If the index is already selected, the operation is ignored.
If the displayText/sendText combination is not found, the operation is ignored.
- Parameters:
-
displayText
- the displayText to select.
-
sendText
- the sendText to select.
- See Also:
- getDisplayText, getSendText, isIndexSelected
selectDisplayText
public abstract void selectDisplayText(String displayText)
- Selects the first occurrence of the specified displayText in the list.
If another index is selected, it will be deselected.
If the index is already selected, the operation is ignored.
If the displayText is not found, the operation is ignored.
- Parameters:
-
displayText
- the displayText to select.
- See Also:
- getDisplayText, getSendText, isIndexSelected
selectSendText
public abstract void selectSendText(String sendText)
- Selects the first occurrence of the specified sendText in the list.
If another index is selected, it will be deselected.
If the index is already selected, the operation is ignored.
If the sendText is not found, the operation is ignored.
- Parameters:
-
sendText
- the sendText to select.
- See Also:
- getDisplayText, getSendText, isIndexSelected
isIndexSelected
public abstract boolean isIndexSelected(int index)
- Checks whether an index is selected.
- Parameters:
-
index
- the index to check
- Returns:
-
true
if the index is selected; false
otherwise.
- See Also:
- select
All Packages Class Hierarchy This Package Previous Next Index