All Packages Class Hierarchy This Package Previous Next Index
Interface com.ibm.hi.customizer.beans.scci.SCCheckbox
- public interface SCCheckbox
- extends SCCustomComponent
A SCCheckbox may have one of two states, ("checked" or "unchecked"), and a sendText
String associated with each state. These sendText Strings will be sent to
the host when the SCCheckbox experiences a state change to maintain
consistency between what it displays and what is actually on the
host. The SCCheckbox also has a displayText String that is the "caption" the user
will see.
-
getDisplayText()
- Gets the displayText.
-
getSendText()
- Gets the sendText associated with the current state of the checkbox.
-
getSendText(boolean)
- Gets the sendText associated with a specified state for the checkbox.
-
isSelected()
-
Determines whether this checkbox is in the "on" or "off" state.
-
setDisplayText(String)
- Sets the displayText.
-
setSelected(boolean)
- Sets the state of this checkbox to the "on"/"off" state.
-
setSendText(String, boolean)
- Sets the sendText for the specified state(checked=
true
,
unchecked=false
).
getDisplayText
public abstract String getDisplayText()
- Gets the displayText.
- Returns:
- the displayText or an empty string if there is none.
- See Also:
- setDisplayText
getSendText
public abstract String getSendText()
- Gets the sendText associated with the current state of the checkbox.
- Returns:
- the sendText or an empty string if there is none.
- See Also:
- setSendText
getSendText
public abstract String getSendText(boolean state)
- Gets the sendText associated with a specified state for the checkbox.
- Parameters:
-
state
- the specified state
- Returns:
- the sendTextor an empty string if there is none.
- See Also:
- setSendText
setDisplayText
public abstract void setDisplayText(String displayText)
- Sets the displayText.
- Parameters:
-
displayText
- the displayText to set
- See Also:
- getDisplayText
setSendText
public abstract void setSendText(String sendText,
boolean state)
- Sets the sendText for the specified state(checked=
true
,
unchecked=false
).
- Parameters:
-
sendText
- the sendText to set.
-
state
- the state for which to send the sendText
- See Also:
- getDisplayText
setSelected
public abstract void setSelected(boolean selected)
- Sets the state of this checkbox to the "on"/"off" state.
- Parameters:
-
selected
- the "on"/"off" state to set
- See Also:
- isSelected
isSelected
public abstract boolean isSelected()
- Determines whether this checkbox is in the "on" or "off" state.
The boolean value
true
indicates the "on" state,
and false
indicates the "off" state.
- Returns:
- the state of this checkbox as a boolean value.
- See Also:
- setSelected
All Packages Class Hierarchy This Package Previous Next Index