com.insightful.controls
Class SplusCheckBox
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
com.insightful.controls.SplusCheckBox
- All Implemented Interfaces:
- SplusControlMethods, ImageObserver, MenuContainer, Serializable
public class SplusCheckBox
- extends JComponent
- implements SplusControlMethods
A check box component sized as a standard S-PLUS control and implementing
SplusControlMetrics.
- See Also:
- Serialized Form
Constructor Summary |
SplusCheckBox(String text)
Constructs a check box component with the specified label. |
SplusCheckBox(String text,
char mnemonic)
Constructs a check box component with the specified label and mnemonic. |
SplusCheckBox(String text,
int mnemonic)
Constructs a check box component with the specified label and mnemonic. |
Method Summary |
void |
addActionListener(ActionListener listener)
Adds an ActionListener to the list of listeners notified when
an ActionEvent occurs, such as when the check box is selected. |
void |
addChangeListener(ChangeListener listener)
Adds a ChangeListener to the list of listeners notified when
a ChangeEvent occurs. |
void |
addItemListener(ItemListener listener)
Adds an ItemListener to the list of listeners notified when
an ItemEvent occurs. |
String |
getActionCommand()
Gets the action command for the check box. |
int |
getMnemonic()
Gets the mnemonic for the check box as an int. |
String[] |
getOptionList()
Required method for SplusControlMethods interface. |
String |
getText()
Gets the text label for the check box. |
String |
getValue()
Gets the value of the check box as a String. |
boolean |
isEnabled()
Checks whether the control is enabled. |
boolean |
isSelected()
Determines whether the check box is selected and returns a boolean. |
void |
setActionCommand(String aCommand)
Sets the action command for the check box. |
void |
setEnabled(boolean b)
Sets whether the control is enabled. |
void |
setMnemonic(char aChar)
Sets the mnemonic for the check box as a char. |
void |
setMnemonic(int key)
Sets the mnemonic for the check box as an int. |
void |
setOptionList(String[] listData)
Required method for SplusControlMethods interface. |
void |
setText(String text)
Sets the text label for the check box. |
void |
setValue(String value)
Sets the value of the check box as a String. |
Methods inherited from class javax.swing.JComponent |
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI |
Methods inherited from class java.awt.Container |
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree |
Methods inherited from class java.awt.Component |
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle |
SplusCheckBox
public SplusCheckBox(String text,
char mnemonic)
- Constructs a check box component with the specified label and mnemonic.
- Parameters:
text
- label for check boxmnemonic
- for check box specified as a char
SplusCheckBox
public SplusCheckBox(String text,
int mnemonic)
- Constructs a check box component with the specified label and mnemonic.
- Parameters:
text
- label for check boxmnemonic
- for check box specified as an int
SplusCheckBox
public SplusCheckBox(String text)
- Constructs a check box component with the specified label.
- Parameters:
text
- label for check box
getValue
public String getValue()
- Gets the value of the check box as a String.
- Specified by:
getValue
in interface SplusControlMethods
- Returns:
- String with value "T" if the check box is selected and
"F" if the check box is not selected.
setValue
public void setValue(String value)
- Sets the value of the check box as a String. Specify "T" to indicate
that the check box is selected or "F" to indicate that the box is
not selected. Any value other than "T" or "TRUE" will be treated
as an "F".
- Specified by:
setValue
in interface SplusControlMethods
- Parameters:
value
- String indicating whether the check box is selected.
getOptionList
public String[] getOptionList()
- Required method for SplusControlMethods interface. Since a check box
has no option list, this method always returns null.
- Specified by:
getOptionList
in interface SplusControlMethods
- Returns:
- a null String
setOptionList
public void setOptionList(String[] listData)
- Required method for SplusControlMethods interface. Since a check box
has no option list, this method has no effect.
- Specified by:
setOptionList
in interface SplusControlMethods
- Parameters:
listData
- array of option list values.
getText
public String getText()
- Gets the text label for the check box.
- Specified by:
getText
in interface SplusControlMethods
- Returns:
- check box label
setText
public void setText(String text)
- Sets the text label for the check box.
- Specified by:
setText
in interface SplusControlMethods
- Parameters:
text
- desired label for the check box
getMnemonic
public int getMnemonic()
- Gets the mnemonic for the check box as an int.
- Specified by:
getMnemonic
in interface SplusControlMethods
- Returns:
- check box mnemonic as an int
setMnemonic
public void setMnemonic(char aChar)
- Sets the mnemonic for the check box as a char.
- Specified by:
setMnemonic
in interface SplusControlMethods
- Parameters:
aChar
- char specifying the mnemonic
setMnemonic
public void setMnemonic(int key)
- Sets the mnemonic for the check box as an int.
- Specified by:
setMnemonic
in interface SplusControlMethods
- Parameters:
key
- int specifying the mnemonic
isEnabled
public boolean isEnabled()
- Checks whether the control is enabled.
- Specified by:
isEnabled
in interface SplusControlMethods
- Overrides:
isEnabled
in class Component
- Returns:
- boolean indicating whether the control is enabled.
setEnabled
public void setEnabled(boolean b)
- Sets whether the control is enabled.
- Specified by:
setEnabled
in interface SplusControlMethods
- Overrides:
setEnabled
in class JComponent
- Parameters:
b
- boolean indicating whether to enable the control.
addActionListener
public void addActionListener(ActionListener listener)
- Adds an ActionListener to the list of listeners notified when
an ActionEvent occurs, such as when the check box is selected.
- Parameters:
listener
- ActionListener to notify when the event occurs
addChangeListener
public void addChangeListener(ChangeListener listener)
- Adds a ChangeListener to the list of listeners notified when
a ChangeEvent occurs.
- Parameters:
listener
- ChangeListener to notify when the event occurs
addItemListener
public void addItemListener(ItemListener listener)
- Adds an ItemListener to the list of listeners notified when
an ItemEvent occurs.
- Parameters:
listener
- ItemListener to notify when the event occurs
getActionCommand
public String getActionCommand()
- Gets the action command for the check box.
- Returns:
- action command.
setActionCommand
public void setActionCommand(String aCommand)
- Sets the action command for the check box.
- Parameters:
aCommand
- the desired action command
isSelected
public boolean isSelected()
- Determines whether the check box is selected and returns a boolean.
This provides a more direct way of checking whether the check box
is selected than getValue().equals("T").
- Returns:
- boolean indicating whether the check box is selected.
Copyright © 2000, 2002 Insightful Corporation
Warning: Classes not documented in the S-PLUS Programmer's Guide may change in future releases.