org.netbeans.spi.htmlui

Class HTMLViewerSpi.Context

java.lang.Object

org.netbeans.spi.htmlui.HTMLViewerSpi.Context

Enclosing interface:

HTMLViewerSpi<HtmlView,HtmlButton>

public static final class HTMLViewerSpi.Context
extends Object

Context for interacting with the system infrastructure. When a new HTML view is requested, it gets instance of this object which it shall use to obtain information and make callbacks into the infrastructure.

Since:

1.23

Method Summary

Modifier and Type	Method and Description
ClassLoader	getClassLoader() The class loader to use.
URL	getPage() The page to display.
String[]	getResources() List of resources available to the page.
String[]	getTechIds() Set of technologies to prefer.
boolean	isBlocking() true if the HTMLViewerSpi.Context.isDialog() is supposed to be blocking.
boolean	isDialog() true if the UI should be presented as a dialog.
boolean	isWindow() true if a long lasting window shall be displayed.
Lookup	onPageLoad() Initialize the page inside of a webview.
boolean	onSubmit(String id) Notify a button has been clicked.

Methods inherited from class java.lang.Object

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

Method Detail

isWindow

public boolean isWindow()

true if a long lasting window shall be displayed.

Returns:

true to display the UI as a window

Since:

1.23

isDialog

public boolean isDialog()

true if the UI should be presented as a dialog.

Returns:

true to display the UI as a dialog

Since:

1.23

isBlocking

public boolean isBlocking()

true if the HTMLViewerSpi.Context.isDialog() is supposed to be blocking. Blocking dialogs in Swing and JavaFX need special care where one has to start a nested event queue. Use this method to find out if such special care is needed.

Returns:

true if the dialog is supposed to block the current thread

Since:

1.23

onSubmit

public boolean onSubmit(String id)

Notify a button has been clicked. As soon as a button is clicked, use this method to notify the code showing a dialog about such event and allow the code to handle/dismiss the click.

Parameters:

id - the ID of the button or null representing unconditional escape or close of the dialog

Returns:

false if the click should be ignored, true if the closing sequence shall continue

Since:

1.23

onPageLoad

public Lookup onPageLoad()

Initialize the page inside of a webview. Call this method once the webview is ready and registered as current Fn.activePresenter(). Let the application code handle its initializations and possibly return a Lookup representing the content of the view.

Dialogs usually return null, but long living windows created via OpenHTMLRegistration usually provide a lookup - see specification on how to fill its content.

Returns:

lookup or null

Since:

1.23

getPage

public URL getPage()

The page to display.

Returns:

the URL of a page to display

Since:

1.23

getClassLoader

public ClassLoader getClassLoader()

The class loader to use. When loading classes or resources dynamically use this classloader.

Returns:

the classloader to use

Since:

1.23

getResources

public String[] getResources()

List of resources available to the page. Resources are at the same relative locations like the page.

Returns:

resources used in the page displayed by the HTML user interface

Since:

1.25

getTechIds

public String[] getTechIds()

Set of technologies to prefer.

Returns:

IDs of technologies to prefer in the HTML user interface

Since:

1.23