org.apache.batik.dom.events
Class DocumentEventSupport

java.lang.Object
  extended by org.apache.batik.dom.events.DocumentEventSupport

public class DocumentEventSupport
extends Object

This class implements the behavior of DocumentEvent.


Nested Class Summary
protected static class DocumentEventSupport.CustomEventFactory
          To create a Custom event.
static interface DocumentEventSupport.EventFactory
          This interface represents an event factory.
protected static class DocumentEventSupport.KeyboardEventFactory
          To create a keyboard event.
protected static class DocumentEventSupport.KeyEventFactory
          To create a key event.
protected static class DocumentEventSupport.MouseEventFactory
          To create a mouse event.
protected static class DocumentEventSupport.MutationEventFactory
          To create a mutation event.
protected static class DocumentEventSupport.MutationNameEventFactory
          To create a mutation name event.
protected static class DocumentEventSupport.SimpleEventFactory
          To create a simple event.
protected static class DocumentEventSupport.TextEventFactory
          To create a Text event.
protected static class DocumentEventSupport.UIEventFactory
          To create a UI event.
 
Field Summary
static String CUSTOM_EVENT_TYPE
          The CustomEvent type.
static String EVENT_DOM2_TYPE
          The Event type.
static String EVENT_TYPE
          The Event type.
protected  HashTable eventFactories
          The event factories table.
static String KEY_EVENT_DOM2_TYPE
          The KeyEvent type.
static String KEYBOARD_EVENT_TYPE
          The KeyEvent type.
static String MOUSE_EVENT_DOM2_TYPE
          The MouseEvent type.
static String MOUSE_EVENT_TYPE
          The MouseEvent type.
static String MUTATION_EVENT_DOM2_TYPE
          The MutationEvent type.
static String MUTATION_EVENT_TYPE
          The MutationEvent type.
static String MUTATION_NAME_EVENT_TYPE
          The MutationNameEvent type.
static String TEXT_EVENT_TYPE
          The TextEvent type.
static String UI_EVENT_DOM2_TYPE
          The UIEvent type.
static String UI_EVENT_TYPE
          The UIEvent type.
 
Constructor Summary
DocumentEventSupport()
           
 
Method Summary
 Event createEvent(String eventType)
          Creates a new Event depending on the specified parameter.
 void registerEventFactory(String eventType, DocumentEventSupport.EventFactory factory)
          Registers a new EventFactory object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EVENT_TYPE

public static final String EVENT_TYPE
The Event type.

See Also:
Constant Field Values

MUTATION_EVENT_TYPE

public static final String MUTATION_EVENT_TYPE
The MutationEvent type.

See Also:
Constant Field Values

MUTATION_NAME_EVENT_TYPE

public static final String MUTATION_NAME_EVENT_TYPE
The MutationNameEvent type.

See Also:
Constant Field Values

MOUSE_EVENT_TYPE

public static final String MOUSE_EVENT_TYPE
The MouseEvent type.

See Also:
Constant Field Values

UI_EVENT_TYPE

public static final String UI_EVENT_TYPE
The UIEvent type.

See Also:
Constant Field Values

KEYBOARD_EVENT_TYPE

public static final String KEYBOARD_EVENT_TYPE
The KeyEvent type.

See Also:
Constant Field Values

TEXT_EVENT_TYPE

public static final String TEXT_EVENT_TYPE
The TextEvent type.

See Also:
Constant Field Values

CUSTOM_EVENT_TYPE

public static final String CUSTOM_EVENT_TYPE
The CustomEvent type.

See Also:
Constant Field Values

EVENT_DOM2_TYPE

public static final String EVENT_DOM2_TYPE
The Event type.

See Also:
Constant Field Values

MUTATION_EVENT_DOM2_TYPE

public static final String MUTATION_EVENT_DOM2_TYPE
The MutationEvent type.

See Also:
Constant Field Values

MOUSE_EVENT_DOM2_TYPE

public static final String MOUSE_EVENT_DOM2_TYPE
The MouseEvent type.

See Also:
Constant Field Values

UI_EVENT_DOM2_TYPE

public static final String UI_EVENT_DOM2_TYPE
The UIEvent type.

See Also:
Constant Field Values

KEY_EVENT_DOM2_TYPE

public static final String KEY_EVENT_DOM2_TYPE
The KeyEvent type.

See Also:
Constant Field Values

eventFactories

protected HashTable eventFactories
The event factories table.

Constructor Detail

DocumentEventSupport

public DocumentEventSupport()
Method Detail

createEvent

public Event createEvent(String eventType)
                  throws DOMException
Creates a new Event depending on the specified parameter.

Parameters:
eventType - The eventType parameter specifies the type of Event interface to be created. If the Event interface specified is supported by the implementation this method will return a new Event of the interface type requested. If the Event is to be dispatched via the dispatchEvent method the appropriate event init method must be called after creation in order to initialize the Event's values. As an example, a user wishing to synthesize some kind of UIEvent would call createEvent with the parameter "UIEvent". The initUIEvent method could then be called on the newly created UIEvent to set the specific type of UIEvent to be dispatched and set its context information.The createEvent method is used in creating Events when it is either inconvenient or unnecessary for the user to create an Event themselves. In cases where the implementation provided Event is insufficient, users may supply their own Event implementations for use with the dispatchEvent method.
Returns:
The newly created Event
Throws:
DOMException - NOT_SUPPORTED_ERR: Raised if the implementation does not support the type of Event interface requested

registerEventFactory

public void registerEventFactory(String eventType,
                                 DocumentEventSupport.EventFactory factory)
Registers a new EventFactory object.



Copyright © 2008 Apache Software Foundation. All Rights Reserved.