org.cruxframework.crux.core.rebind.screen.widget.declarative

Annotation Type DeclarativeFactory

@Retention(value=RUNTIME)
@Target(value=TYPE)
public @interface DeclarativeFactory

Author:

Thiago da Rosa de Bustamante

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	id Widget Identifier under the library being defined.
String	library The name of the library that will contain this widget.
Class<? extends com.google.gwt.user.client.ui.IsWidget>	targetWidget The widget class associated with the annotated factory.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	attachToDOM if false, the annotated widgetFactory will not be attached to DOM.
String	description A description to be used to compose the documentation of the generated library
boolean	htmlContainer HTMLContainers are widgets that can have innerHTML content AND, at same time, are Panels, (that can receive another widgets as children).
String	illustration An image to illustrate the widget referenced by this factory.
String	infoURL An info URL to be used to compose the documentation of the generated library

Element Detail

id

public abstract String id

Widget Identifier under the library being defined. Crux will generate an element with this ID on the library associated XSD file.

library

public abstract String library

The name of the library that will contain this widget. Crux will generate one XSD file per library

targetWidget

public abstract Class<? extends com.google.gwt.user.client.ui.IsWidget> targetWidget

The widget class associated with the annotated factory.

description

public abstract String description

A description to be used to compose the documentation of the generated library

Default:

""

infoURL

public abstract String infoURL

An info URL to be used to compose the documentation of the generated library

Default:

""

illustration

public abstract String illustration

An image to illustrate the widget referenced by this factory. It will be used to compose the documentation of the generated library

Default:

""

attachToDOM

public abstract boolean attachToDOM

if false, the annotated widgetFactory will not be attached to DOM. It will only be logically attached to the View object

Default:

true

htmlContainer

public abstract boolean htmlContainer

HTMLContainers are widgets that can have innerHTML content AND, at same time, are Panels, (that can receive another widgets as children). The transformation made at server side, during Crux pages compilation, keeps the html content inside the <span> tag, that marks the widget position. It allows ScreenFactory to just wrap those elements into created widget, for a very better performance.

Default:

false