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

All Superinterfaces:
SCCustomComponent

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.


Method Summary
 java.lang.String getDisplayText()
          Gets the displayText.
 java.lang.String getSendText()
          Gets the sendText associated with the current state of the checkbox.
 java.lang.String getSendText(boolean state)
          Gets the sendText associated with a specified state for the checkbox.
 boolean isSelected()
          Determines whether this checkbox is in the "on" or "off" state.
 void setDisplayText(java.lang.String displayText)
          Sets the displayText.
 void setSelected(boolean selected)
          Sets the state of this checkbox to the "on"/"off" state.
 void setSendText(java.lang.String sendText, boolean state)
          Sets the sendText for the specified state(checked=true, unchecked=false).
 
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

getDisplayText

public java.lang.String getDisplayText()
Gets the displayText.
Returns:
the displayText or an empty string if there is none.
See Also:
setDisplayText(java.lang.String)

getSendText

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

getSendText

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

setDisplayText

public void setDisplayText(java.lang.String displayText)
Sets the displayText.
Parameters:
displayText - the displayText to set
See Also:
getDisplayText()

setSendText

public void setSendText(java.lang.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 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 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(boolean)