S-PLUS Connect/Java v1.0

com.insightful.controls
Class SplusCheckBox

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended bycom.insightful.controls.SplusCheckBox
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, SplusControlMethods

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

Nested Class Summary
 
Nested classes inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
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, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SplusCheckBox

public SplusCheckBox(String text,
                     char mnemonic)
Constructs a check box component with the specified label and mnemonic.

Parameters:
text - label for check box
mnemonic - 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 box
mnemonic - 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
Method Detail

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
Returns:
check box mnemonic as a char

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
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
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.

S-PLUS Connect/Java v1.0

Copyright © 2000, 2002 Insightful Corporation
Warning: Classes not documented in the S-PLUS Programmer's Guide may change in future releases.