org.netbeans.spi.htmlui

Interface HTMLViewerSpi<HtmlView,HtmlButton>

Type Parameters:

HtmlView - type representing the view as used by this viewer

HtmlButton - type representing buttons as used by this viewer

public interface HTMLViewerSpi<HtmlView,HtmlButton>

Service provider interface for handing display of HTML based user interface. Code using OpenHTMLRegistration, HTMLDialog and HTMLComponent assumes the system to display the HTML page and connect it with the underlaying code - that's a task for this SPI.

Implement this interface and register it using ServiceProvider. When requested (via HTMLViewerSpi.newView(org.netbeans.spi.htmlui.HTMLViewerSpi.Context) method show the HTML page and run the initialization code in the page. There are three possible ways to display an HTML user interface: long lasting window, dialog with extra buttons, a separate HTMLViewerSpi.component(java.lang.Object, java.lang.Class) to embed into existing Swing or JavaFX interface.

Since:

1.23

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	HTMLViewerSpi.Context Context for interacting with the system infrastructure.

Method Summary

Modifier and Type	Method and Description
<C> C	component(HtmlView view, Class<C> type) Converts the view to a component of the requested type.
HtmlButton	createButton(HtmlView view, String id) Create a button.
String	getId(HtmlView view, HtmlButton b) Extracts ID of a button created by HTMLViewerSpi.createButton(java.lang.Object, java.lang.String).
HtmlView	newView(HTMLViewerSpi.Context context) Create new HTML view.
void	runLater(HtmlView view, Runnable r) Runs a batch operation over the buttons in given view.
void	setEnabled(HtmlView view, HtmlButton b, boolean enabled) Sets enablement state for a button created by HTMLViewerSpi.createButton(java.lang.Object, java.lang.String).
void	setText(HtmlView view, HtmlButton b, String text) Sets text for a button created by HTMLViewerSpi.createButton(java.lang.Object, java.lang.String).

Method Detail

newView

HtmlView newView(HTMLViewerSpi.Context context)

Create new HTML view. Based on values of provided context show either:

• window - when HTMLViewerSpi.Context.isWindow() handles OpenHTMLRegistration usages
• dialog - when HTMLViewerSpi.Context.isDialog() handles HTMLDialog usages
• embedable component - when none of above - handles HTMLComponent usages

Parameters:

context - information to display and callbacks to the infrastructure

Returns:

any element representing the view or null if this viewer cannot handle the request

Since:

1.23

component

<C> C component(HtmlView view,
                Class<C> type)

Converts the view to a component of the requested type. This method is only called if neither HTMLViewerSpi.Context.isWindow() and HTMLViewerSpi.Context.isDialog() return true. Default implementation supports two values of type: JComponent or javafx.scene.Node class - alternative implementations of this interface may not support all these types and may also support other types.

Requesting Void.class means to realize the component - e.g. make it visible.

Type Parameters:

C - the type of requested component

Parameters:

view - element representing the view

type - class of the requested component

Returns:

instance of the component

Throws:

ClassCastException - if the type isn't supported

Since:

1.23

createButton

HtmlButton createButton(HtmlView view,
                        String id)

Create a button. Buttons are parsed from the HTML page as HTMLDialog specification describes. This method allows one to create for example Swing buttons outside of the HTML page to keep consistent user experience.

Parameters:

view - the view

id - identification of the button

Returns:

any element representing the button

Since:

1.23

getId

String getId(HtmlView view,
             HtmlButton b)

Extracts ID of a button created by HTMLViewerSpi.createButton(java.lang.Object, java.lang.String).

Parameters:

view - the view

b - the button

Returns:

the ID associated with the button

Since:

1.23

setText

void setText(HtmlView view,
             HtmlButton b,
             String text)

Sets text for a button created by HTMLViewerSpi.createButton(java.lang.Object, java.lang.String).

Parameters:

view - the view

b - the button

text - new text to assign to the button

Since:

1.23

setEnabled

void setEnabled(HtmlView view,
                HtmlButton b,
                boolean enabled)

Sets enablement state for a button created by HTMLViewerSpi.createButton(java.lang.Object, java.lang.String).

Parameters:

view - the view

b - the button

enabled - the desired enablement state

Since:

1.23

runLater

void runLater(HtmlView view,
              Runnable r)

Runs a batch operation over the buttons in given view.

Parameters:

view - the view

r - the batch operation

Since:

1.23