org.netbeans.api.htmlui

Annotation Type OpenHTMLRegistration

@Retention(value=SOURCE)
 @Target(value=METHOD)
public @interface OpenHTMLRegistration

Registers an action to open an HTML (possibly with HTML for Java integration). The essential aspect is to create an HTML page and reference its location via OpenHTMLRegistration.url() attribute. The page may contain any JavaScript, but as we are Java developers, it is preferrable to rather use HTML for Java API. In such case the associated static method (which is annotated by this annotation) will be called once the HTML page is loaded. One is expected to instantiate class generated by the Model annotation and call applyBindings() on it. Here is an example:

@Model(className="UI", properties={
  @Property(name = "text", type = String.class)
})
public final class UICntrl {
  @ActionID(
     category = "Tools",
     id = "my.sample.HtmlHelloWorld"
  )
  @ActionReferences({
    @ActionReference(path = "Menu/Tools"),
    @ActionReference(path = "Toolbars/File"),
  })
  @NbBundle.Messages("CTL_OpenHtmlHelloWorld=Open HTML Hello World!")
  @OpenHTMLRegistration(
    url = "ui.html",
    displayName = "#CTL_OpenHtmlHelloWorld"
  )
  public static UI onPageLoad() {
    return new UI("Hello World!").applyBindings();
  }
}
 

The above would display a new action in Toolbar and in Menu that would, upon invocation, open up a new component displaying the ui.html page. The page can use Knockout.js bindings like <input data-bind="value: text"></input> to reference properties defined by the Model annotation in the generated class UI.

In addition to the above, there is a special support for influencing action context and thus turning on and off various actions shown in menu and toolbar. Just define @Property(name = "context", type = String.class, array = true) and put into it fully qualified names of classes you want to expose in the context. Those classes should be public and have public constructor that takes instance of the model class returned from the annotated method (e.g. UI in the above example). The system will instantiate them appropriatelly and will make sure they are available in the action context. If the interface also implements Closeable, its close method is invoked once the instance is removed from the context to handle clean up.

Since:

0.7.6

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	displayName
String	url URL to the HTML page to display in the view.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	iconBase Icon base for the action (and also the view) that shows the HTML page.
String[]	techIds Selects some of provided technologies.

Element Detail

url

public abstract String url

URL to the HTML page to display in the view.

Returns:

relative or absolute URL to page to display

displayName

public abstract String displayName

iconBase

public abstract String iconBase

Icon base for the action (and also the view) that shows the HTML page.

Returns:

the path to the base 16x16 icon

Default:

""

techIds

public abstract String[] techIds

Selects 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 this attribute.

Returns:

list of preferred technology ids

Since:

1.3

Default:

{}