xapi.ui.html.api

Annotation Type HtmlTemplate

public @interface HtmlTemplate

Author:

"James X. Nelson (james@wetheinter.net)"

Field Summary

Fields

Modifier and Type	Fields and Description
static String	KEY_CHILDREN
static String	KEY_CONTEXT
static String	KEY_PARENT
static String	KEY_VALUE

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Import[]	imports
boolean	inherit
String	name
Class<?>[]	references
String	template
String[]	templateKeys
boolean	wrapsChildren

Field Detail

KEY_PARENT

public static final String KEY_PARENT

KEY_CHILDREN

public static final String KEY_CHILDREN

KEY_CONTEXT

public static final String KEY_CONTEXT

KEY_VALUE

public static final String KEY_VALUE

Element Detail

inherit

public abstract boolean inherit

Returns:

true if you want the annotations on the template to be applied. Leave false (default) to have the template treated as a named child, to be applied by some other Html, El or HtmlTemplate.

Default:

false

wrapsChildren

public abstract boolean wrapsChildren

Default:

false

name

public abstract String name

Returns:

any string to allow ${bean.naming} references to this template.

Default:

""

template

public abstract String template

Returns:

An optional template to be parsed for replacement keys

Default:

""

templateKeys

public abstract String[] templateKeys

Returns:

The default "global" keys you want to handle.

Unless you are implementing your own generator, the only reason to set this variable will be to declare aliases to snippets of code that will be within scope in generated code.

To use an alias, use a templateKey in the form of "keyName:scopedObject.doSomething".

If you use Import tags, you can _try_ using short classnames, however a fully qualified reference to type names is recommended.
static imports with unique names is general the safest way to make concise references in template values.

Default:

{"$value", "$children", "$parent", "$ctx"}

imports

public abstract Import[] imports

Default:

{}

references

public abstract Class<?>[] references

Returns:

classes to use to extract Html, El and Style data from.

Default:

{}