org.codefx.libfx.control.webview

Class WebViews

java.lang.Object

org.codefx.libfx.control.webview.WebViews

public final class WebViews
extends Object

Usability methods for the WebView.

Method Summary

Modifier and Type	Method and Description
static WebViewHyperlinkListenerHandle	addHyperlinkListener(javafx.scene.web.WebView webView, WebViewHyperlinkListener listener) Creates a listener handle and immediately attaches it.
static WebViewHyperlinkListenerHandle	addHyperlinkListener(javafx.scene.web.WebView webView, WebViewHyperlinkListener listener, HyperlinkEvent.EventType eventType) Creates a listener handle and immediately attaches it.
static boolean	canConvertToHyperlinkEvent(Event domEvent) Indicates whether the specified DOM event can be converted to a HyperlinkEvent.
static HyperlinkEvent	convertToHyperlinkEvent(Event domEvent, Object source) Converts the specified DOM event to a hyperlink event.
static WebViewHyperlinkListenerHandle	createHyperlinkListenerHandle(javafx.scene.web.WebView webView, WebViewHyperlinkListener listener) Creates a handle with which the specified listener can be attached to the specified web view.
static WebViewHyperlinkListenerHandle	createHyperlinkListenerHandle(javafx.scene.web.WebView webView, WebViewHyperlinkListener listener, HyperlinkEvent.EventType eventType) Creates a handle with which the specified listener can be attached to the specified web view.
static String	domEventToString(Event event) Returns a string representation of the specified event.
static String	hyperlinkEventToString(HyperlinkEvent event) Returns a string representation of the specified event.

Methods inherited from class java.lang.Object

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

Method Detail

createHyperlinkListenerHandle

public static WebViewHyperlinkListenerHandle createHyperlinkListenerHandle(javafx.scene.web.WebView webView,
                                                                           WebViewHyperlinkListener listener)

Creates a handle with which the specified listener can be attached to the specified web view.

Once attached, the listener will be called on any event on an hyperlink (i.e. any element with tag name "a") which can be represented as a HyperlinkEvent. This is the case on MOUSE_ENTER, MOUSE_LEAVE and CLICK.

Parameters:

webView - the WebView to which the listener will be added

listener - the WebViewHyperlinkListener to add to the web view

Returns:

a handle on the created listener which allows to attach and detach it; initially detached

See Also:

addHyperlinkListener(WebView, WebViewHyperlinkListener)

createHyperlinkListenerHandle

public static WebViewHyperlinkListenerHandle createHyperlinkListenerHandle(javafx.scene.web.WebView webView,
                                                                           WebViewHyperlinkListener listener,
                                                                           HyperlinkEvent.EventType eventType)

Creates a handle with which the specified listener can be attached to the specified web view.

Once attached, the listener will be called on any event on an hyperlink (i.e. any element with tag name "a") which can be represented as a HyperlinkEvent with the specified event type. See DomEventType.toHyperlinkEventType() for the conversion of event types.

Parameters:

webView - the WebView to which the listener will be added

listener - the WebViewHyperlinkListener to add to the web view

eventType - the HyperlinkEvent.EventType of all events passed to the listener

Returns:

a handle on the created listener which allows to attach and detach it; initially detached

See Also:

addHyperlinkListener(WebView, WebViewHyperlinkListener, HyperlinkEvent.EventType)

addHyperlinkListener

public static WebViewHyperlinkListenerHandle addHyperlinkListener(javafx.scene.web.WebView webView,
                                                                  WebViewHyperlinkListener listener)

Creates a listener handle and immediately attaches it.

Parameters:

webView - the WebView to which the listener will be added

listener - the WebViewHyperlinkListener to add to the web view

Returns:

a handle on the created listener which allows to attach and detach it; initially attached

See Also:

createHyperlinkListenerHandle(WebView, WebViewHyperlinkListener)

addHyperlinkListener

public static WebViewHyperlinkListenerHandle addHyperlinkListener(javafx.scene.web.WebView webView,
                                                                  WebViewHyperlinkListener listener,
                                                                  HyperlinkEvent.EventType eventType)

Creates a listener handle and immediately attaches it.

Parameters:

webView - the WebView to which the listener will be added

listener - the WebViewHyperlinkListener to add to the web view

eventType - the HyperlinkEvent.EventType of all events passed to the listener

Returns:

a handle on the created listener which allows to attach and detach it; initially attached

See Also:

createHyperlinkListenerHandle(WebView, WebViewHyperlinkListener, HyperlinkEvent.EventType)

canConvertToHyperlinkEvent

public static 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 static 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

Throws:

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

hyperlinkEventToString

public static String hyperlinkEventToString(HyperlinkEvent event)

Returns a string representation of the specified event.

Parameters:

event - the HyperlinkEvent which will be converted to a string

Returns:

a string representation of the event

domEventToString

public static String domEventToString(Event event)

Returns a string representation of the specified event.

Parameters:

event - the DOM-Event which will be converted to a string

Returns:

a string representation of the event