org.netbeans.api.htmlui

Class HTMLDialog.Builder

java.lang.Object

org.netbeans.api.htmlui.HTMLDialog.Builder

Enclosing class:

HTMLDialog

public static final class HTMLDialog.Builder
extends Object

Rather than using this class directly, consider HTMLDialog. The HTMLDialog annotation generates boilderplate code for you and can do some compile times checks helping you to get warnings as soon as possible.

Method Summary

Modifier and Type	Method and Description
HTMLDialog.Builder	addResources(String... res) Registers resources to be available for the HTMLDialog.url() page.
HTMLDialog.Builder	addTechIds(String... ids) Requests some of provided technologies.
<C> C	component(Class<C> type) Obtains the component from the builder.
HTMLDialog.Builder	loadFinished(Runnable run) Registers a runnable to be executed when the page becomes ready.
static HTMLDialog.Builder	newDialog(String url) Starts creation of a new HTML dialog.
void	show(HTMLDialog.OnSubmit s) Displays the dialog and returns immediately.
String	showAndWait() Displays the dialog and waits.

Methods inherited from class java.lang.Object

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

Method Detail

newDialog

public static HTMLDialog.Builder newDialog(String url)

Starts creation of a new HTML dialog. The page can contain hidden buttons as described at HTMLDialog.

Parameters:

url - URL (usually using nbresloc protocol) of the page to display in the dialog.

Returns:

instance of the builder

loadFinished

public HTMLDialog.Builder loadFinished(Runnable run)

Registers a runnable to be executed when the page becomes ready.

Parameters:

run - runnable to run

Returns:

this builder

addResources

public HTMLDialog.Builder addResources(String... res)

Registers resources to be available for the HTMLDialog.url() page. The rendering system shall make sure these resources are available when the main page is loaded and are at the same relative locations like the page.

Parameters:

res - list of resources to add to the builder

Returns:

instance of the builder

Since:

1.25

addTechIds

public HTMLDialog.Builder addTechIds(String... ids)

Requests some of provided technologies. The HTML/Java API @ version 1.1 supports technology ids. One can specify the preferred ones to use in this NetBeans component by using calling this method.

Parameters:

ids - list of preferred technology ids to add to the builder

Returns:

instance of the builder

Since:

1.3

showAndWait

public String showAndWait()

Displays the dialog and waits. This method blocks waiting for the dialog to be shown and closed by the user.

Returns:

'id' of a selected button element or null if the dialog was closed without selecting a button

show

public void show(HTMLDialog.OnSubmit s)

Displays the dialog and returns immediately.

Parameters:

s - callback to call when a button is clicked and dialog is about to be closed

Since:

1.23

component

public <C> C component(Class<C> type)

Obtains the component from the builder. The parameter can either be JFXPanel.class or WebView.class. After calling this method the builder becomes useless.

Type Parameters:

C - requested component type

Parameters:

type - either JFXPanel or WebView class

Returns:

instance of the requested component