Package org.apache.juneau.html

Class HtmlBeanPropertyMeta

java.lang.Object

org.apache.juneau.ExtendedMeta

org.apache.juneau.ExtendedBeanPropertyMeta

org.apache.juneau.html.HtmlBeanPropertyMeta

public class HtmlBeanPropertyMeta
extends ExtendedBeanPropertyMeta

Metadata on bean properties specific to the HTML serializers and parsers pulled from the @Html annotation on the bean property.

See Also:

• HTML Basics

Field Summary

Fields

Modifier and Type	Field	Description
static final HtmlBeanPropertyMeta	DEFAULT	Default instance.

Constructor Summary

Constructors

Constructor	Description
HtmlBeanPropertyMeta(BeanPropertyMeta bpm, AnnotationProvider ap, HtmlMetaProvider mp)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getAnchorText()	Specifies the anchor text for this property.
protected HtmlFormat	getFormat()	Returns the format of this bean property
String	getLink()	Adds a hyperlink to this value in HTML.
HtmlRender	getRender()	Returns the render class for rendering the style and contents of this property value in HTML.
String	getStyle()	Returns the CSS style string for this property.
protected boolean	isHtml()	Returns true if getFormat() returns HtmlFormat.HTML.
protected boolean	isHtmlCdc()	Returns true if getFormat() returns HtmlFormat.HTML_CDC.
protected boolean	isHtmlSdc()	Returns true if getFormat() returns HtmlFormat.HTML_SDC.
boolean	isNoTableHeaders()	Returns whether this bean property should not include table headers when serialized as an HTML table.
protected boolean	isNoTables()	Returns whether this bean property should not be serialized as an HTML table.
protected boolean	isPlainText()	Returns true if getFormat() returns HtmlFormat.PLAIN_TEXT.
protected boolean	isXml()	Returns true if getFormat() returns HtmlFormat.XML.

Methods inherited from class org.apache.juneau.ExtendedBeanPropertyMeta

getBeanPropertyMeta

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT

public static final HtmlBeanPropertyMeta DEFAULT

Default instance.

Constructor Details

HtmlBeanPropertyMeta

public HtmlBeanPropertyMeta(BeanPropertyMeta bpm,
 AnnotationProvider ap,
 HtmlMetaProvider mp)

Constructor.

Parameters:

bpm - The metadata of the bean property of this additional metadata.

ap - The annotation provider.

mp - HTML metadata provider (for finding information about other artifacts).

Method Details

getAnchorText

public String getAnchorText()

Specifies the anchor text for this property.

This value is specified via the @Html(anchorText) annotation.

Returns:

The link string, or null if not specified.

getLink

public String getLink()

Adds a hyperlink to this value in HTML.

This value is specified via the @Html(link) annotation.

Returns:

The link string, or null if not specified.

getRender

public HtmlRender getRender()

Returns the render class for rendering the style and contents of this property value in HTML.

This value is specified via the @Html(render) annotation.

Returns:

The render class, never null.

getStyle

public String getStyle()

Returns the CSS style string for this property.

This value is specified via the @Html(style) annotation.

Returns:

The CSS style string, or null if not specified.

isNoTableHeaders

public boolean isNoTableHeaders()

Returns whether this bean property should not include table headers when serialized as an HTML table.

Returns:

true if the the @Html annotation is specified, and @Html(noTableHeaders) is true.

getFormat

protected HtmlFormat getFormat()

Returns the format of this bean property

Returns:

The value of the Html.format() annotation.

isHtml

protected boolean isHtml()

Returns true if getFormat() returns HtmlFormat.HTML.

Returns:

true if getFormat() returns HtmlFormat.HTML.

isHtmlCdc

protected boolean isHtmlCdc()

Returns true if getFormat() returns HtmlFormat.HTML_CDC.

Returns:

true if getFormat() returns HtmlFormat.HTML_CDC.

isHtmlSdc

protected boolean isHtmlSdc()

Returns true if getFormat() returns HtmlFormat.HTML_SDC.

Returns:

true if getFormat() returns HtmlFormat.HTML_SDC.

isNoTables

protected boolean isNoTables()

Returns whether this bean property should not be serialized as an HTML table.

Returns:

true if the the @Html annotation is specified, and @Html(noTables) is true.

isPlainText

protected boolean isPlainText()

Returns true if getFormat() returns HtmlFormat.PLAIN_TEXT.

Returns:

true if getFormat() returns HtmlFormat.PLAIN_TEXT.

isXml

protected boolean isXml()

Returns true if getFormat() returns HtmlFormat.XML.

Returns:

true if getFormat() returns HtmlFormat.XML.