org.codefx.libfx.dom

Class DomEventConverter

java.lang.Object

org.codefx.libfx.dom.DomEventConverter

public final class DomEventConverter
extends Object

Converts DOM Events to Swing's HyperlinkEvents.

This class is thread-safe, i.e. the provided methods can be called from different threads and concurrent executions do not interfere with each other.

Constructor Summary

Constructors

Constructor and Description
DomEventConverter()

Method Summary

Modifier and Type	Method and Description
boolean	canConvertToHyperlinkEvent(Event domEvent) Indicates whether the specified DOM event can be converted to a HyperlinkEvent.
HyperlinkEvent	convertToHyperlinkEvent(Event domEvent, Object source) Converts the specified DOM event to a hyperlink event.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DomEventConverter

public DomEventConverter()

Method Detail

canConvertToHyperlinkEvent

public boolean canConvertToHyperlinkEvent(Event domEvent)

Indicates whether the specified DOM event can be converted to a HyperlinkEvent.

Parameters:

domEvent - the DOM-Event

Returns:

true if the event's type has an equivalent EventType

convertToHyperlinkEvent

public HyperlinkEvent convertToHyperlinkEvent(Event domEvent,
                                              Object source)
                                       throws IllegalArgumentException

Converts the specified DOM event to a hyperlink event.

Parameters:

domEvent - the DOM-Event from which the HyperlinkEvent will be created

source - the source of the domEvent

Returns:

a HyperlinkEvent with the following properties:

• getEventType() returns the HyperlinkEvent.EventType corresponding to the domEvent's type as defined by DomEventType
• getSource() returns the specified source
• getUrl() returns the href-attribute's value of the event's source element
• getDescription() returns the text content of the event's source element
• getInputEvent() returns null
• getSourceElement() returns null

Throws:

IllegalArgumentException - if the specified event can not be converted to a hyperlink event; this is the case if canConvertToHyperlinkEvent(Event) returns false