Package org.apache.juneau.html.annotation

Annotation Interface HtmlConfig

@Target({TYPE,METHOD})
@Retention(RUNTIME)
@Inherited
@ContextApply({SerializerApply.class,ParserApply.class})
public @interface HtmlConfig

Annotation for specifying config properties defined in HtmlSerializer, HtmlParser, and HtmlDocSerializer.

Used primarily for specifying bean configuration properties on REST classes and methods.

See Also:

• HTML Basics

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	addBeanTypes	Add "_type" properties when needed.
String	addKeyValueTableHeaders	Add key/value headers on bean/map tables.
String	disableDetectLabelParameters	Don't look for link labels in URIs.
String	disableDetectLinksInStrings	Don't look for URLs in Strings.
String	labelParameter	Link label parameter name.
int	rank	Optional rank for this config.
String	uriAnchorText	Anchor text source.

Element Details

rank

int rank

Optional rank for this config.

Can be used to override default ordering and application of config annotations.

Returns:

The annotation value.

Default:

0

addBeanTypes

String addBeanTypes

Add "_type" properties when needed.

If true, then "_type" properties will be added to beans if their type cannot be inferred through reflection.

When present, this value overrides the Serializer.Builder.addBeanTypes() setting and is provided to customize the behavior of specific serializers in a SerializerSet.

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• HtmlSerializer.Builder.addBeanTypesHtml()

Returns:

The annotation value.

Default:

""

addKeyValueTableHeaders

String addKeyValueTableHeaders

Add key/value headers on bean/map tables.

When enabled, key and value column headers are added to tables.

The following shows the difference between the two generated outputs:

withoutHeaders	withHeaders
f1 foo f2 bar	key value f1 foo f2 bar

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• HtmlSerializer.Builder.addKeyValueTableHeaders()

Returns:

The annotation value.

Default:

""

disableDetectLinksInStrings

String disableDetectLinksInStrings

Don't look for URLs in Strings.

Disables the feature where if a string looks like a URL (i.e. starts with "http://" or "https://", then treat it like a URL and make it into a hyperlink based on the rules specified by HtmlSerializer.Builder.uriAnchorText(AnchorText).

The following shows the difference between the two generated outputs:

withLinks	withoutLinks
key value f1 http://www.apache.org	key value f1 http://www.apache.org

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• HtmlSerializer.Builder.disableDetectLinksInStrings()

Returns:

The annotation value.

Default:

""

labelParameter

String labelParameter

Link label parameter name.

The parameter name to look for when resolving link labels.

Notes:

• Default value: "label"
• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• HtmlSerializer.Builder.labelParameter(String)

Returns:

The annotation value.

Default:

""

disableDetectLabelParameters

String disableDetectLabelParameters

Don't look for link labels in URIs.

Disables the feature where if the URL has a label parameter (e.g. "?label=foobar"), then use that as the anchor text of the link.

The parameter name can be changed via the HtmlSerializer.Builder.labelParameter(String) property.

The following shows the difference between the two generated outputs.
Note that they're both hyperlinks, but the anchor text differs:

withLabels	withoutLabels
key value f1 Apache Foundation	key value f1 http://www.apache.org?label=Apache%20Foundation

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• HtmlSerializer.Builder.disableDetectLabelParameters()

Returns:

The annotation value.

Default:

""

uriAnchorText

String uriAnchorText

Anchor text source.

When creating anchor tags (e.g. <a href='...' >text</a>) in HTML, this setting defines what to set the inner text to.

• "TO_STRING" - Set to whatever is returned by Annotation.toString() on the object.
• "PROPERTY_NAME" - Set to the bean property name.
• "URI" - Set to the URI value.
• "LAST_TOKEN" - Set to the last token of the URI value.
• "URI_ANCHOR" - Set to the anchor of the URL.
• "CONTEXT_RELATIVE" - Same as "TO_STRING" but assumes it's a context-relative path.
• "SERVLET_RELATIVE" - Same as "TO_STRING" but assumes it's a servlet-relative path.
• "PATH_RELATIVE" - Same as "TO_STRING" but assumes it's a path-relative path.

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• HtmlSerializer.Builder.uriAnchorText(AnchorText)

Returns:

The annotation value.

Default:

""