public class ActiveFrame extends Frame
Frame<TT>java.awt.Frame</TT> with a channel interface.
All channels are optional. The configure and event channels are settable from a constructor. The event channel delivers a WindowEvent whenever one is generated on the ActiveFrame. 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 myWindowEvent = Channel.createOne2One (new OverWriteOldestBuffer (n)); final One2OneChannel myMouseEvent = Channel.createOne2One (new OverWriteOldestBuffer (n)); final ActiveFrame myFrame = new ActiveFrame (myWindowEvent.out ()); myFrame.addMouseEventChannel (myMouseEvent.out ());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.
Input Channels | ||
---|---|---|
configure | Boolean |
|
ActiveFrame.Configure | Invoke the user-defined Configure.configure method on the frame. | |
Output Channels | ||
event | WindowEvent | The WindowEvent generated by the component |
containerEvent | ContainerEvent | See the addContainerEventChannel<TT>addContainerEventChannel</TT> method. |
componentEvent | ComponentEvent | See the addComponentEventChannel<TT>addComponentEventChannel</TT> method. |
focusEvent | FocusEvent | See the addFocusEventChannel<TT>addFocusEventChannel</TT> method. |
keyEvent | KeyEvent | See the addKeyEventChannel<TT>addKeyEventChannel</TT> method. |
mouseEvent | MouseEvent | See the addMouseEventChannel<TT>addMouseEventChannel</TT> method. |
mouseMotionEvent | MouseEvent | See the addMouseMotionEventChannel<TT>addMouseMotionEventChannel</TT> method. |
import java.awt.*; import java.awt.event.*; import org.jcsp.lang.*; import org.jcsp.util.*; import org.jcsp.awt.*; public class ActiveFrameButtonExample { public static void main (String argv[]) { final Any2OneChannel windowEvent = Channel.createAny2One (new OverWriteOldestBuffer (10)); final ActiveFrame frame = new ActiveFrame (null, windowEvent.out (), "ActiveButton Example"); final String[] label = {"Hello World", "Rocket Science", "CSP", "Monitors", "Ignore Me", "Goodbye World"}; final Any2OneChannel buttonEvent = Channel.createAny2One (new OverWriteOldestBuffer (10)); final ActiveButton[] button = new ActiveButton[label.length]; for (int i = 0; i < label.length; i++) { button[i] = new ActiveButton (null, buttonEvent.out (), label[i]); } frame.setSize (300, 200); frame.setLayout (new GridLayout (label.length/2, 2)); for (int i = 0; i < label.length; i++) { frame.add (button[i]); } frame.setVisible (true); new Parallel ( new CSProcess[] { new Parallel (button), new CSProcess () { // respond to window events public void run () { boolean running = true; while (running) { final WindowEvent w = (WindowEvent) windowEvent.in ().read (); switch (w.getID ()) { case WindowEvent.WINDOW_CLOSING: System.out.println ("*** WINDOW_CLOSING ..."); running = false; break; default: System.out.println (w); break; } } frame.setVisible (false); System.exit (0); } }, new CSProcess () { // respond to button events public void run () { boolean running = true; while (running) { final String s = (String) buttonEvent.in ().read (); System.out.println ("Button `" + s + "' pressed ..."); running = (s != label[label.length - 1]); } frame.setVisible (false); System.exit (0); } } } ).run (); } }
Modifiers | Name | Description |
---|---|---|
static interface |
ActiveFrame.Configure |
This enables general configuration of this component. |
Fields inherited from class | Fields |
---|---|
class Frame |
DEFAULT_CURSOR, CROSSHAIR_CURSOR, TEXT_CURSOR, WAIT_CURSOR, SW_RESIZE_CURSOR, SE_RESIZE_CURSOR, NW_RESIZE_CURSOR, NE_RESIZE_CURSOR, N_RESIZE_CURSOR, S_RESIZE_CURSOR, W_RESIZE_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, MOVE_CURSOR, NORMAL, ICONIFIED, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MAXIMIZED_BOTH, TOP_ALIGNMENT, CENTER_ALIGNMENT, BOTTOM_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, WIDTH, HEIGHT, PROPERTIES, SOMEBITS, FRAMEBITS, ALLBITS, ERROR, ABORT |
class Window |
TOP_ALIGNMENT, CENTER_ALIGNMENT, BOTTOM_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, WIDTH, HEIGHT, PROPERTIES, SOMEBITS, FRAMEBITS, ALLBITS, ERROR, ABORT |
Constructor and description |
---|
ActiveFrame
() Constructs a new ActiveFrame with no title and no configuration or event channels. |
ActiveFrame
(String title) Constructs a new ActiveFrame with a title but no configuration or event channels. |
ActiveFrame
(ChannelInput configure, ChannelOutput event) Constructs a new ActiveFrame with configuration and event channels, but no title. |
ActiveFrame
(ChannelInput configure, ChannelOutput event, String title) Constructs a new ActiveFrame with configuration and event channels and a title. |
Type | Name and description |
---|---|
void |
addComponentEventChannel(ChannelOutput componentEvent) Add a new channel to this component that will be used to notify that a ComponentEvent has occurred. |
void |
addContainerEventChannel(ChannelOutput containerEvent) Add a new channel to this component that will be used to notify that a ContainerEvent 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 ActiveFrame. |
Constructs a new ActiveFrame with no title and no configuration or event channels.
Constructs a new ActiveFrame with a title but no configuration or event channels.
title
- the title for the frame.Constructs a new ActiveFrame with configuration and event channels, but no title.
configure
- the channel for configuration events
-- can be null if no configuration is required.event
- a WindowEvent will be output whenever it occurs
-- can be null if no notification is required.Constructs a new ActiveFrame with configuration and event channels and a title.
configure
- the channel for configuration events
-- can be null if no configuration is required.event
- a WindowEvent will be output whenever it occurs
-- can be null if no notification is required.title
- the title for the frame.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.
componentEvent
- the channel down which to send ComponentEvents.Add a new channel to this component that will be used to notify that a ContainerEvent has occurred. This should be used instead of registering a ContainerListener 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.
containerEvent
- the channel down which to send ContainerEvents.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.
focusEvent
- the channel down which to send FocusEvents.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.
keyEvent
- the channel down which to send KeyEvents.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.
mouseEvent
- the channel down which to send MouseEvents.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.
mouseMotionEvent
- the channel down which to send MouseMotionEvents.The main body of this process.
Sets the configuration channel for this ActiveFrame. This method overwrites any configuration channel set in the constructor.
configure
- the channel for configuration events
-- can be null if no configuration is required.JCSP for Java 1.8 generated 14-10-2016 by Jon Kerridge, Edinburgh Napier University - j dot kerridge at napier dot ac dot uk