org.netbeans.api.htmlui

Annotation Type HTMLComponent

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

Generates factory method in class specified by HTMLComponent.className() that will return a component of requested HTMLComponent.type() which can later be embedded into Swing or JavaFX UI elements. When the factory method is called, it returns immediately and starts loading of the specified HTML page. Once the page is ready it calls back method annotated by this annotation to finish initialization. The method is supposed to make the page live, preferably by using Model generated class and calling applyBindings() on it.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<?>	type The type of component to generate.
String	url URL of the page to display.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	className Name of the file to generate the method that opens the dialog into.
String[]	techIds Selects some of provided technologies.

Element Detail

url

public abstract String url

URL of the page to display. Usually relative to the annotated class. Will be resolved by the annotation processor and converted into nbresloc protocol - as such the HTML page can be L10Ned later by adding classical L10N suffixes. E.g. index_cs.html will take preceedence over index.html if the user is running in Czech Locale.

Returns:

relative path the HTML page

type

public abstract Class<?> type

The type of component to generate. Currently supports two types: Swing and JavaFX. To request Swing component return JComponent.class. To request JavaFX component, return Node.class.

Returns:

either JComponent or Node class

className

public abstract String className

Name of the file to generate the method that opens the dialog into. Class of such name will be generated into the same package.

Returns:

name of class to generate

Default:

"Pages"

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:

{}