org.apache.juneau.html.annotation

Annotation Type Html

@Documented
 @Target(value={TYPE,FIELD,METHOD})
 @Retention(value=RUNTIME)
 @Inherited
public @interface Html

Annotation that can be applied to classes, fields, and methods to tweak how they are handled by HtmlSerializer.

See Also:

• Overview > juneau-marshall > HTML Details > @Html Annotation

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	anchorText Use the specified anchor text when serializing a URI.
boolean	asPlainText Deprecated. - Use format=HtmlFormat.PLAINTEXT.
boolean	asXml Deprecated. - Use format=HtmlFormat.XML.
HtmlFormat	format Specifies what format to use for the HTML element.
String	link Adds a hyperlink to a bean property when rendered as HTML.
boolean	noTableHeaders When true, don't add headers to tables.
boolean	noTables When true, collections of beans should be rendered as trees instead of tables.
Class<? extends HtmlRender>	render Associates an HtmlRender with a bean property for custom HTML rendering of the property.

Element Detail

anchorText

public abstract String anchorText

Use the specified anchor text when serializing a URI.

The text can contain any bean property values resolved through variables of the form "{property-name}".

Example:

// Produces <a href='...'>drive</a> when serialized to HTML. @Html(anchorText="drive") @URI // Treat property as a URL public String getDrive() {...}

This overrides the behavior specified by HtmlSerializer.HTML_uriAnchorText.

Default:

""

format

public abstract HtmlFormat format

Specifies what format to use for the HTML element.

Default:

org.apache.juneau.html.annotation.HtmlFormat.HTML

asPlainText

@Deprecated
public abstract boolean asPlainText

Deprecated. - Use format=HtmlFormat.PLAINTEXT.

Default:

false

asXml

@Deprecated
public abstract boolean asXml

Deprecated. - Use format=HtmlFormat.XML.

Default:

false

link

public abstract String link

Adds a hyperlink to a bean property when rendered as HTML.

The text can contain any bean property values resolved through variables of the form "{property-name}".

The URLs can be any of the following forms:

• Absolute - e.g. "http://host:123/myContext/myServlet/myPath"
• Context-root-relative - e.g. "/myContext/myServlet/myPath"
• Context-relative - e.g. "context:/myServlet/myPath"
• Servlet-relative - e.g. "servlet:/myPath"
• Path-info-relative - e.g. "myPath"

Example:

public class FileSpace { @Html(link="servlet:/drive/{drive}") public String getDrive() { ...; } }

Default:

""

noTableHeaders

public abstract boolean noTableHeaders

When true, don't add headers to tables.

See Also:

• HtmlSerializer.HTML_addKeyValueTableHeaders

Default:

false

noTables

public abstract boolean noTables

When true, collections of beans should be rendered as trees instead of tables.

Default is false.

Default:

false

render

public abstract Class<? extends HtmlRender> render

Associates an HtmlRender with a bean property for custom HTML rendering of the property.

This annotation applies to bean properties and classes.

Default:

org.apache.juneau.html.HtmlRender.class