Skip navigation links
org.netbeans.api.htmlui 1.10

HTML UI API
Official

See: Description

HTML UI API 
Package Description
org.netbeans.api.htmlui
NetBeans specific annotations to embed the HTML for Java UI into a window, dialog or elsewhere.

HTMLUI NetBeans Platform specific bindings over standard HTML for Java API.

What is New (see all changes)?

Use Cases

Primary purpose of this API is to allow smooth use of HTML based UI in NetBeans Platform. To achieve that it provides specific annotatations like @OpenHTMLRegistration, but otherwise it builds on the same usecases as the HTML for Java API.

Portable HTML based Window
Want to open a live HTML page as a NetBeans window component? Do you want to use Java to control enabled/disabled state of various HTML elements? Then have a look at @OpenHTMLRegistration annotation.
Portable HTML based Dialog
Want to open a modal dialog filled with an HTML page and block until user makes his choice? Then have a look at @HTMLDialog annotation.
Embedding an HTML UI Component
Are you satisfied with your HTML UI as used in windows and dialogs, but you'd like to use it at a different part of the overall NetBeans UI? Then check @HTMLComponent annotation.
HTML and Java Wizard
It is possible to use this technology to create a wizard. See HTML and Java Wizard howto.

Exported Interfaces

This table lists all of the module exported APIs with defined stability classifications. It is generated based on answers to questions about the architecture of the module. Read them all...
Group of java interfaces
Interface NameIn/OutStabilitySpecified in What Document?
HTMLUIExportedOfficial

NetBeans Platform specific bindings over standard
HTML for Java API.

Group of property interfaces
Interface NameIn/OutStabilitySpecified in What Document?
data-netbeans-cssExportedOfficial

Each browser component created by one of the annotations (
@HTMLComponent, @HTMLDialog, @OpenHTMLRegistration ) is by default skinned with a CSS that makes it look like the the other Swing components. This can be disabled when defining your HTML page:
<html>
<head data-netbeans-html="false">
</head>
</html>
If there is the data-netbeans-html attribute equal to "false", then no special NetBeans CSS tricks are applied.

Implementation Details

Where are the sources for the module?

The sources for the module are in the NetBeans Mercurial repositories.

What do other modules need to do to declare a dependency on this one, in addition to or instead of a plain module dependency?

The HTML for Java & NetBeans API is a classical NetBeans module. However it depends on other modules provided by the HTML for Java project and those are OSGi bundles. As such, when one decides to use this module, one needs to turn on an OSGi container inside of the NetBeans Platform. It can be either Felix or NetBeans version of Equinox.

Read more about the implementation in the answers to architecture questions.

Skip navigation links
org.netbeans.api.htmlui 1.10