All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class jcsp.awt.event.FocusEventHandler

java.lang.Object
   |
   +----jcsp.awt.event.FocusEventHandler

public class FocusEventHandler
extends Object
implements CSProcess, FocusListener

Process Diagram

   ___________________
  |                   | event
  | FocusEventHandler |--->---
  |___________________|
 

Description

The FocusEventHandler class is not intended to be used by software constructors, instead it is used in the construction of new Active AWT Components that generate FocusEvents (i.e. ActiveButton, ActiveScrollbar).

The FocusEventHandler class implements the FocusListener interface and can be used for any Component which allows the addition of a FocusListener. When the Component is created a new instance of the FocusEventHandler should be created and added as a FocusListener to the Component. The process must be set running (either asynchronously using ProcessNetwork or as part of a Parallel construct).

The main body of this process waits to be notified by a component invoking the focusGained() or focusLost() methods. The process then wakes up and sends the FocusEvent object down the event Channel. Any further calls to the methods while the process is writing will be discarded so as not to block the main Java event Thread. When another process reads from the Channel this process loops round and waits to be notified again.

Channel Protocols

Input Channels
Output Channels
event FocusEvent The FocusEvent generated by the Component.

Example

Extending an Existing Component

 import java.awt.*;
 import jcsp.lang.*;
 import jcsp.awt.event.*;
 public class ChannelComponent extends Component implements CSProcess {
   FocusEventHanlder handler;
   public ChannelComponent() {
   }
   public void addFocusEventChannel(ChannelOutput event) {
     if (event !=null) {
       handler = new FocusEventHanlder(event);
       addFocusListener(handler);
     }
   }
   public void run() {
     if (handler != null) {
       handler.run();
     }
   }
 }
 
NOTE: This is in fact how the jcsp awt components add Channels for other event types.

Listening to a Component

 import java.awt.*;
 import jcsp.awt.event.*;
 import jcsp.lang.*;
        :
        :
   {
     final Channel event = new One2OneChannel();
     Component c = new Button("Active");
     add(c);
     FocusEventHanlder handler = new FocusEventHanlder(event);
     c.addFocusListener(handler);
     new Parallel(new CSProcess[] {
       c,
       handler,
       new CSProcess() {
         public void run() {
           while (true) {
             Object o = event.read();
             System.out.println("FocusEvent '" + o);
           }
         }
       }
     }).run();
   }
 }
 

Author:
P.D.Austin

Constructor Index

 o FocusEventHandler(ChannelOutput)
constructs a new FocusEventHandler with the specified output Channel.

Method Index

 o focusGained(FocusEvent)
Invoked when the Component the event handler is listening to Gains the input Focus.
 o focusLost(FocusEvent)
Invoked when the Component the event handler is listening to Gains the input Focus.
 o run()
The main body of the process.

Constructors

 o FocusEventHandler
 public FocusEventHandler(ChannelOutput event)
constructs a new FocusEventHandler with the specified output Channel.

Parameters:
event - The Channel to send the event notification down

Methods

 o focusGained
 public void focusGained(FocusEvent e)
Invoked when the Component the event handler is listening to Gains the input Focus. Notifies the event process that a FocusEvent has occurred by sending the FocusEvent Object. Some notifications will be lost so there are no guarantees that all events generated will be processed.

Parameters:
e - The parameters associated with this event
 o focusLost
 public void focusLost(FocusEvent e)
Invoked when the Component the event handler is listening to Gains the input Focus. Notifies the event process that a FocusEvent has occurred by sending the FocusEvent Object. Some notifications will be lost so there are no guarantees that all events generated will be processed.

Parameters:
e - The parameters associated with this event
 o run
 public void run()
The main body of the process. Executes the functionality described above.


All Packages  Class Hierarchy  This Package  Previous  Next  Index