Class ActiveCheckbox
- All Implemented Interfaces:
ImageObserver
,ItemSelectable
,MenuContainer
,Serializable
,Accessible
,CSProcess
java.awt.Checkbox
with a channel interface.
Process Diagram
Description
ActiveCheckbox is a process extension of java.awt.Checkbox with channels for run-time configuration and event notification. The event channels should be connected to one or more application-specific server processes (instead of registering a passive object as a Listener to this component).All channels are optional. The configure and event channels are settable from a constructor. The event channel delivers the generated java.awt.ItemEvent whenever the ActiveCheckbox is operated. Other event channels can be added to notify the occurrence of any other events the component generates (by calling the appropriate addXXXEventChannel method before the process is run). Messages can be sent down the configure channel at any time to configure the component. See the table below for details.
All channels are managed by independent internal handler processes. It is, therefore, safe for a serial application process both to service an event channel and configure the component -- no deadlock can occur.
IMPORTANT: it is essential that event channels from this process are always serviced -- otherwise the Java Event Thread will be blocked and the GUI will stop responding. A simple way to guarantee this is to use channels configured with overwriting buffers. For example:
final One2OneChannel myCheckboxEvent = Channel.one2one (new OverWriteOldestBuffer (n)); final ActiveCheckbox myCheckbox = new ActiveCheckbox (null, myCheckboxEvent);This will ensure that the Java Event Thread will never be blocked. Slow or inattentive readers may miss rapidly generated events, but the n most recent events will always be available.
Channel Protocols
Input Channels | ||
---|---|---|
configure | String | Change the label for the ActiveCheckbox to the value of the String. |
Boolean |
|
|
ActiveCheckbox.Configure | Invoke the user-defined Configure.configure method on the checkbox. | |
Output Channels | ||
event | ItemEvent | When the ActiveCheckbox is operated, the generated java.awt.ItemEvent is written down this channel. |
componentEvent | ComponentEvent | See the addComponentEventChannel method. |
focusEvent | FocusEvent | See the addFocusEventChannel method. |
keyEvent | KeyEvent | See the addKeyEventChannel method. |
mouseEvent | MouseEvent | See the addMouseEventChannel method. |
mouseMotionEvent | MouseEvent | See the addMouseMotionEventChannel method. |
Example
import java.awt.*; import java.awt.event.*; import org.jcsp.lang.*; import org.jcsp.util.*; import org.jcsp.awt.*; public class ActiveCheckboxExample { public static void main (String argv[]) { final Frame root = new Frame ("ActiveCheckbox Example"); final String[] box = {"Hello World", "Rocket Science", "CSP", "Monitors", "Ignore Me", "Goodbye World"}; final Any2OneChannel event = Channel.any2one (new OverWriteOldestBuffer (10)); final ActiveCheckbox[] check = new ActiveCheckbox[box.length]; for (int i = 0; i < box.length; i++) { check[i] = new ActiveCheckbox (null, event.out (), box[i]); } root.setSize (300, 200); root.setLayout (new GridLayout (box.length, 1)); for (int i = 0; i < box.length; i++) { root.add (check[i]); } root.setVisible (true); new Parallel ( new CSProcess[] { new Parallel (check), new CSProcess () { public void run () { boolean running = true; while (running) { final ItemEvent e = (ItemEvent) event.in ().read (); final String item = (String) e.getItem (); if (e.getStateChange () == ItemEvent.SELECTED) { System.out.println ("Checked ==> `" + item + "'"); running = (item != box[box.length - 1]); } else { System.out.println ("Unchecked ==> `" + item + "'"); } } root.setVisible (false); System.exit (0); } } } ).run (); } }
- Author:
- P.D. Austin and P.H. Welch
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
This enables general configuration of this component.Nested classes/interfaces inherited from class java.awt.Checkbox
Checkbox.AccessibleAWTCheckbox
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
-
Field Summary
Fields inherited from class java.awt.Component
accessibleContext, 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
ConstructorsConstructorDescriptionConstructs an ActiveCheckbox with no label, initial state false and no configuration or event channels.Constructs an ActiveCheckbox with the label s, initial state false and no configuration or event channels.ActiveCheckbox
(String s, boolean state) Constructs an ActiveCheckbox with the label s, initial state and no configuration or event channels.ActiveCheckbox
(String s, boolean state, CheckboxGroup group) Constructs an ActiveCheckbox in the CheckboxGroup group with the label s, initial state and no configuration or event channels.ActiveCheckbox
(ChannelInput configure, ChannelOutput event) Constructs an ActiveCheckbox with no label, initial state false and configuration and event channels.ActiveCheckbox
(ChannelInput configure, ChannelOutput event, String s) Constructs a ActiveCheckbox with the label s, initial state false and configuration and event channels.ActiveCheckbox
(ChannelInput configure, ChannelOutput event, String s, boolean state) Constructs an ActiveCheckbox with the label s, initial state and configuration and event channels.ActiveCheckbox
(ChannelInput configure, ChannelOutput event, String s, boolean state, CheckboxGroup group) Constructs an ActiveCheckbox in the CheckboxGroup group with the label s, initial state and configuration and event channels. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addComponentEventChannel
(ChannelOutput componentEvent) Add a new channel to this component that will be used to notify that a ComponentEvent has occurred.void
addFocusEventChannel
(ChannelOutput focusEvent) Add a new channel to this component that will be used to notify that a FocusEvent has occurred.void
addKeyEventChannel
(ChannelOutput keyEvent) Add a new channel to this component that will be used to notify that a KeyEvent has occurred.void
addMouseEventChannel
(ChannelOutput mouseEvent) Add a new channel to this component that will be used to notify that a MouseEvent has occurred.void
addMouseMotionEventChannel
(ChannelOutput mouseMotionEvent) Add a new channel to this component that will be used to notify that a MouseMotionEvent has occurred.void
run()
The main body of this process.void
setConfigureChannel
(ChannelInput configure) Sets the configuration channel for this ActiveCheckbox.Methods inherited from class java.awt.Checkbox
addItemListener, addNotify, getAccessibleContext, getCheckboxGroup, getItemListeners, getLabel, getListeners, getSelectedObjects, getState, paramString, processEvent, processItemEvent, removeItemListener, setCheckboxGroup, setLabel, setState
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, revalidate, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setMixingCutoutShape, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validate
-
Constructor Details
-
ActiveCheckbox
public ActiveCheckbox()Constructs an ActiveCheckbox with no label, initial state false and no configuration or event channels. -
ActiveCheckbox
Constructs an ActiveCheckbox with the label s, initial state false and no configuration or event channels.- Parameters:
s
- the label displayed on the ActiveCheckbox.
-
ActiveCheckbox
Constructs an ActiveCheckbox with the label s, initial state and no configuration or event channels.- Parameters:
s
- the label displayed on the ActiveCheckbox.state
- the initial state of the ActiveCheckbox (true => on, false => off).
-
ActiveCheckbox
Constructs an ActiveCheckbox in the CheckboxGroup group with the label s, initial state and no configuration or event channels.- Parameters:
s
- the label displayed on the ActiveCheckbox.state
- the initial state of the ActiveCheckbox. (true => on, false => off)group
- the CheckboxGroup for the ActiveCheckbox.
-
ActiveCheckbox
Constructs an ActiveCheckbox with no label, initial state false and configuration and event channels.- Parameters:
configure
- the channel for configuration events -- can be null if no configuration is required.event
- the ItemEvent will be output when the choice is exercised -- can be null if no notification is required.
-
ActiveCheckbox
Constructs a ActiveCheckbox with the label s, initial state false and configuration and event channels.- Parameters:
configure
- the channel for configuration events -- can be null if no configuration is required.event
- the ItemEvent will be output when the choice is exercised -- can be null if no notification is required.s
- the label displayed on the ActiveCheckbox.
-
ActiveCheckbox
Constructs an ActiveCheckbox with the label s, initial state and configuration and event channels.- Parameters:
configure
- the channel for configuration events -- can be null if no configuration is required.event
- the ItemEvent will be output when the choice is exercised -- can be null if no notification is required.s
- the label displayed on the ActiveCheckbox.state
- the initial state of the ActiveCheckbox. (true => on, false => off)
-
ActiveCheckbox
public ActiveCheckbox(ChannelInput configure, ChannelOutput event, String s, boolean state, CheckboxGroup group) Constructs an ActiveCheckbox in the CheckboxGroup group with the label s, initial state and configuration and event channels.- Parameters:
configure
- the channel for configuration events -- can be null if no configuration is required.event
- the ItemEvent will be output when the choice is exercised -- can be null if no notification is required.s
- the label displayed on the ActiveCheckbox.state
- the initial state of the ActiveCheckbox. (true => on, false => off)group
- the CheckboxGroup for the ActiveCheckbox.
-
-
Method Details
-
setConfigureChannel
Sets the configuration channel for this ActiveCheckbox. This method overwrites any configuration channel set in the constructor.- Parameters:
configure
- the channel for configuration events -- can be null if no configuration is required.
-
addComponentEventChannel
Add a new channel to this component that will be used to notify that a ComponentEvent has occurred. This should be used instead of registering a ComponentListener with the component. It is possible to add more than one channel by calling this method multiple times If the channel passed is null, no action will be taken.NOTE: This method must be called before this process is run.
- Parameters:
componentEvent
- the channel down which to send ComponentEvents.
-
addFocusEventChannel
Add a new channel to this component that will be used to notify that a FocusEvent has occurred. This should be used instead of registering a FocusListener with the component. It is possible to add more than one channel by calling this method multiple times If the channel passed is null, no action will be taken.NOTE: This method must be called before this process is run.
- Parameters:
focusEvent
- the channel down which to send FocusEvents.
-
addKeyEventChannel
Add a new channel to this component that will be used to notify that a KeyEvent has occurred. This should be used instead of registering a KeyListener with the component. It is possible to add more than one channel by calling this method multiple times If the channel passed is null, no action will be taken.NOTE: This method must be called before this process is run.
- Parameters:
keyEvent
- the channel down which to send KeyEvents.
-
addMouseEventChannel
Add a new channel to this component that will be used to notify that a MouseEvent has occurred. This should be used instead of registering a MouseListener with the component. It is possible to add more than one channel by calling this method multiple times If the channel passed is null, no action will be taken.NOTE: This method must be called before this process is run.
- Parameters:
mouseEvent
- the channel down which to send MouseEvents.
-
addMouseMotionEventChannel
Add a new channel to this component that will be used to notify that a MouseMotionEvent has occurred. This should be used instead of registering a MouseMotionListener with the component. It is possible to add more than one channel by calling this method multiple times If the channel passed is null, no action will be taken.NOTE: This method must be called before this process is run.
- Parameters:
mouseMotionEvent
- the channel down which to send MouseMotionEvents.
-
run
public void run()The main body of this process.
-