ControlBeans
Class CCheckBox

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.AbstractButton
                          |
                          +--javax.swing.JToggleButton
                                |
                                +--javax.swing.JCheckBox
                                      |
                                      +--ControlBeans.CCheckBox

public class CCheckBox

extends javax.swing.JCheckBox

implements java.awt.event.ActionListener, ComponentInterface

This class implements a checkbox as a control component. Its purpose is to provide the user with a selectable/deselectable component. When clicked, this component will send either '0' or '1' to the communicator, depending on whether it's checked or not.
It has been implemented as a Javabean, meaning that it is well suited to use within visual programming tools such as NetBeans or JBuilder.

See Also:

Serialized Form

Inner classes inherited from class javax.swing.JCheckBox

javax.swing.JCheckBox.AccessibleJCheckBox

Inner classes inherited from class javax.swing.JToggleButton

javax.swing.JToggleButton.AccessibleJToggleButton, javax.swing.JToggleButton.ToggleButtonModel

Inner classes inherited from class javax.swing.AbstractButton

javax.swing.AbstractButton.AccessibleAbstractButton, javax.swing.AbstractButton.ButtonChangeListener

Inner classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Fields inherited from class javax.swing.AbstractButton

actionListener, BORDER_PAINTED_CHANGED_PROPERTY, changeEvent, changeListener, CONTENT_AREA_FILLED_CHANGED_PROPERTY, DISABLED_ICON_CHANGED_PROPERTY, DISABLED_SELECTED_ICON_CHANGED_PROPERTY, FOCUS_PAINTED_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, itemListener, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, model, MODEL_CHANGED_PROPERTY, PRESSED_ICON_CHANGED_PROPERTY, ROLLOVER_ENABLED_CHANGED_PROPERTY, ROLLOVER_ICON_CHANGED_PROPERTY, ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, SELECTED_ICON_CHANGED_PROPERTY, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

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

DEFAULT_ID

Constructor Summary

CCheckBox()
Constructs a new CCheckBox.

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e) Invoked when a user selects or deselects this component.
void	addComponentListener(ComponentListener l) Registers a ComponentListener.
boolean	getIsReceiver() Gets whether or not this component will receive values.
boolean	getIsSender() Gets whether or not this component will send values.
int	getTag() Gets the tag of this component.
int[]	getTags() The communicator uses this method to get all the tags used by this component.
void	putValue(double value, int aTag, double time, int ID) Sets the value of this component.
void	putValue(int value, int aTag, double time, int ID) Sets the value for this component.
void	putValue(java.lang.String value, int aTag, double time, int ID) Sets the value of this component.
void	registerCommunicator(AbstractCommunicator c, int ID) The communicator uses this method to alert this component of its presence.
void	removeComponentListener(ComponentListener l) Deregisters the ComponentListener.
void	requestValues() Called by the communicator to make this component send its value(s).
void	setIsReceiver(boolean value) Sets whether or not this component should receive values.
void	setIsSender(boolean value) Sets whether or not this component should send values.
void	setTag(int value) Sets the tag of this component.

Methods inherited from class javax.swing.JCheckBox

getAccessibleContext, getUIClassID, paramString, updateUI

Methods inherited from class javax.swing.AbstractButton

addActionListener, addChangeListener, addItemListener, checkHorizontalKey, checkVerticalKey, createActionListener, createChangeListener, createItemListener, doClick, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getActionCommand, getDisabledIcon, getDisabledSelectedIcon, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getLabel, getMargin, getMnemonic, getModel, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, init, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, paintBorder, removeActionListener, removeChangeListener, removeItemListener, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setEnabled, setFocusPainted, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setLabel, setMargin, setMnemonic, setMnemonic, setModel, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getWidth, getVisibleRect, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, processComponentKeyEvent, processFocusEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setFont, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setCursor, setLayout, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hide, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CCheckBox

public CCheckBox()

Constructs a new CCheckBox.

Method Detail

getIsReceiver

public boolean getIsReceiver()

Gets whether or not this component will receive values.

Specified by:

getIsReceiver in interface ComponentInterface

Returns:

true if this component will receive values to the communicator; false otherwise.

setIsReceiver

public void setIsReceiver(boolean value)

Sets whether or not this component should receive values.

Specified by:

setIsReceiver in interface ComponentInterface

Parameters:

value - true if this component should receive values from the communicator; false otherwise.

getIsSender

public boolean getIsSender()

Gets whether or not this component will send values.

Specified by:

getIsSender in interface ComponentInterface

Returns:

true if this component will send values to the communicator; false otherwise.

setIsSender

public void setIsSender(boolean value)

Sets whether or not this component should send values.

Specified by:

setIsSender in interface ComponentInterface

Parameters:

value - true if this component should send values to the communicator; false otherwise.

getTag

public int getTag()

Gets the tag of this component. The tag is used to group different components within the communicator.

Returns:

the tag of this component

setTag

public void setTag(int value)

Sets the tag of this component. The tag is used to group different components within the communicator.

Parameters:

value - the tag of this component

addComponentListener

public void addComponentListener(ComponentListener l)

Registers a ComponentListener. By doing so the ComponentListener can receive component events from this component.
NOTE: This component can only hold one ComponentListener.

Specified by:

addComponentListener in interface ComponentInterface

Parameters:

l - the ComponentListener to register.

removeComponentListener

public void removeComponentListener(ComponentListener l)

Deregisters the ComponentListener.

Specified by:

removeComponentListener in interface ComponentInterface

Parameters:

l - the ComponentListener to remove.

registerCommunicator

public void registerCommunicator(AbstractCommunicator c,
                                 int ID)

The communicator uses this method to alert this component of its presence.
NOTE: This method is invoked by AbstractCommunicator and should therefore never be called directly by the user.

Specified by:

registerCommunicator in interface ComponentInterface

Parameters:

c - the communicator in question

ID - the ID number assigned to this component and is stored in myID

See Also:

putValue(int, int, double, int), putValue(double, int, double, int), putValue(java.lang.String, int, double, int)

getTags

public int[] getTags()

The communicator uses this method to get all the tags used by this component.
NOTE: This method is invoked by AbstractCommunicator and should therefore never be called directly by the user.

Specified by:

getTags in interface ComponentInterface

Returns:

all tags used by this component

putValue

public void putValue(int value,
                     int aTag,
                     double time,
                     int ID)

Sets the value for this component.

Specified by:

putValue in interface ComponentInterface

Parameters:

value - the value to be set

aTag - the tag of the component

time - a time tag for the value

ID - the ID of the component

See Also:

registerCommunicator(ControlBeans.AbstractCommunicator, int)

putValue

public void putValue(double value,
                     int aTag,
                     double time,
                     int ID)

Sets the value of this component.
NOTE: Implemented for compatibility reasons only. This component cannot receive double values, hence calling this method will have no effect.

Specified by:

putValue in interface ComponentInterface

Parameters:

value - the value to be set

aTag - the tag of the component

time - a time tag for the value

ID - the ID of the component

See Also:

registerCommunicator(ControlBeans.AbstractCommunicator, int)

putValue

public void putValue(java.lang.String value,
                     int aTag,
                     double time,
                     int ID)

Sets the value of this component.
NOTE: Implemented for compatibility reasons only. This component cannot receive string values, hence calling this method will have no effect.

Specified by:

putValue in interface ComponentInterface

Parameters:

value - the value to be set

aTag - the tag of the component

time - a time tag for the value

ID - the ID of the component

See Also:

registerCommunicator(ControlBeans.AbstractCommunicator, int)

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Invoked when a user selects or deselects this component. If a communicator has registered with it, it will result in a value being sent to the communicator. If this component is checked, the value will be '1'. If not, the value '0' will be sent.
NOTE: This method is invoked by the AWT event handling and should therefore never be called directly by the user.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

e - the event describing that someone clicked this component

See Also:

AbstractCommunicator.putValue(java.lang.String, int, double, int)

requestValues

public void requestValues()

Called by the communicator to make this component send its value(s). This can be used for initialization.

Specified by:

requestValues in interface ComponentInterface