Package org.apache.batik.dom.events
Class DocumentEventSupport
- java.lang.Object
-
- org.apache.batik.dom.events.DocumentEventSupport
-
public class DocumentEventSupport extends java.lang.Object
This class implements the behavior of DocumentEvent.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description 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
Fields Modifier and Type Field Description static java.lang.String
CUSTOM_EVENT_TYPE
The CustomEvent type.static java.lang.String
EVENT_DOM2_TYPE
The Event type.static java.lang.String
EVENT_TYPE
The Event type.protected java.util.HashMap<java.lang.String,DocumentEventSupport.EventFactory>
eventFactories
The event factories table.static java.lang.String
KEY_EVENT_DOM2_TYPE
The KeyEvent type.static java.lang.String
KEYBOARD_EVENT_TYPE
The KeyEvent type.static java.lang.String
MOUSE_EVENT_DOM2_TYPE
The MouseEvent type.static java.lang.String
MOUSE_EVENT_TYPE
The MouseEvent type.static java.lang.String
MUTATION_EVENT_DOM2_TYPE
The MutationEvent type.static java.lang.String
MUTATION_EVENT_TYPE
The MutationEvent type.static java.lang.String
MUTATION_NAME_EVENT_TYPE
The MutationNameEvent type.static java.lang.String
TEXT_EVENT_TYPE
The TextEvent type.static java.lang.String
UI_EVENT_DOM2_TYPE
The UIEvent type.static java.lang.String
UI_EVENT_TYPE
The UIEvent type.
-
Constructor Summary
Constructors Constructor Description DocumentEventSupport()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Event
createEvent(java.lang.String eventType)
Creates a new Event depending on the specified parameter.void
registerEventFactory(java.lang.String eventType, DocumentEventSupport.EventFactory factory)
Registers a new EventFactory object.
-
-
-
Field Detail
-
EVENT_TYPE
public static final java.lang.String EVENT_TYPE
The Event type.- See Also:
- Constant Field Values
-
MUTATION_EVENT_TYPE
public static final java.lang.String MUTATION_EVENT_TYPE
The MutationEvent type.- See Also:
- Constant Field Values
-
MUTATION_NAME_EVENT_TYPE
public static final java.lang.String MUTATION_NAME_EVENT_TYPE
The MutationNameEvent type.- See Also:
- Constant Field Values
-
MOUSE_EVENT_TYPE
public static final java.lang.String MOUSE_EVENT_TYPE
The MouseEvent type.- See Also:
- Constant Field Values
-
UI_EVENT_TYPE
public static final java.lang.String UI_EVENT_TYPE
The UIEvent type.- See Also:
- Constant Field Values
-
KEYBOARD_EVENT_TYPE
public static final java.lang.String KEYBOARD_EVENT_TYPE
The KeyEvent type.- See Also:
- Constant Field Values
-
TEXT_EVENT_TYPE
public static final java.lang.String TEXT_EVENT_TYPE
The TextEvent type.- See Also:
- Constant Field Values
-
CUSTOM_EVENT_TYPE
public static final java.lang.String CUSTOM_EVENT_TYPE
The CustomEvent type.- See Also:
- Constant Field Values
-
EVENT_DOM2_TYPE
public static final java.lang.String EVENT_DOM2_TYPE
The Event type.- See Also:
- Constant Field Values
-
MUTATION_EVENT_DOM2_TYPE
public static final java.lang.String MUTATION_EVENT_DOM2_TYPE
The MutationEvent type.- See Also:
- Constant Field Values
-
MOUSE_EVENT_DOM2_TYPE
public static final java.lang.String MOUSE_EVENT_DOM2_TYPE
The MouseEvent type.- See Also:
- Constant Field Values
-
UI_EVENT_DOM2_TYPE
public static final java.lang.String UI_EVENT_DOM2_TYPE
The UIEvent type.- See Also:
- Constant Field Values
-
KEY_EVENT_DOM2_TYPE
public static final java.lang.String KEY_EVENT_DOM2_TYPE
The KeyEvent type.- See Also:
- Constant Field Values
-
eventFactories
protected java.util.HashMap<java.lang.String,DocumentEventSupport.EventFactory> eventFactories
The event factories table.
-
-
Method Detail
-
createEvent
public Event createEvent(java.lang.String eventType) throws org.w3c.dom.DOMException
Creates a new Event depending on the specified parameter.- Parameters:
eventType
- TheeventType
parameter specifies the type ofEvent
interface to be created. If theEvent
interface specified is supported by the implementation this method will return a newEvent
of the interface type requested. If theEvent
is to be dispatched via thedispatchEvent
method the appropriate event init method must be called after creation in order to initialize theEvent
's values. As an example, a user wishing to synthesize some kind ofUIEvent
would callcreateEvent
with the parameter "UIEvent". TheinitUIEvent
method could then be called on the newly createdUIEvent
to set the specific type of UIEvent to be dispatched and set its context information.ThecreateEvent
method is used in creatingEvent
s when it is either inconvenient or unnecessary for the user to create anEvent
themselves. In cases where the implementation providedEvent
is insufficient, users may supply their ownEvent
implementations for use with thedispatchEvent
method.- Returns:
- The newly created
Event
- Throws:
org.w3c.dom.DOMException
- NOT_SUPPORTED_ERR: Raised if the implementation does not support the type ofEvent
interface requested
-
registerEventFactory
public void registerEventFactory(java.lang.String eventType, DocumentEventSupport.EventFactory factory)
Registers a new EventFactory object.
-
-