org.itsnat.core.domutil
Interface ElementLabel

All Superinterfaces:

ElementGroup, ItsNatUserData

public interface ElementLabel
extends ElementGroup

This utility interface is used to render a value inside the associated DOM element using a pattern. The content of the DOM element is used as pattern to render the first value and consecutive values if isUsePatternMarkupToRender() returns true.

Objects implementing this interface are attached to the specified DOM element this element usually is not empty.

Author:

Jose Maria Arranz Santamaria

Method Summary

void	addLabelMarkup() Adds the label pattern markup inside the label element.
void	addLabelMarkup(java.lang.Object value) Adds the label pattern markup inside the label element and renders the specified value.
org.w3c.dom.DocumentFragment	getContentPatternFragment() Returns the pattern used to render values if isUsePatternMarkupToRender() is true.
ElementLabelRenderer	getElementLabelRenderer() Returns the current renderer used by this label.
boolean	hasLabelMarkup() Informs whether this label contains markup.
boolean	isUsePatternMarkupToRender() Informs whether the original (saved as pattern) markup is used to render.
void	removeLabelMarkup() Removes the label markup inside the label element.
void	setElementLabelRenderer(ElementLabelRenderer renderer) Sets the renderer used by this label.
void	setLabelValue(java.lang.Object value) Renders the specified value into the label using the current renderer.
void	setUsePatternMarkupToRender(boolean value) Sets whether the original (saved as pattern) markup is used to render.

Methods inherited from interface org.itsnat.core.domutil.ElementGroup

getItsNatDocument, getParentElement

Methods inherited from interface org.itsnat.core.ItsNatUserData

containsUserValueName, getUserValue, getUserValueNames, removeUserValue, setUserValue

Method Detail

getElementLabelRenderer

ElementLabelRenderer getElementLabelRenderer()

Returns the current renderer used by this label.

Returns:

the current renderer.

See Also:

setElementLabelRenderer(ElementLabelRenderer)

setElementLabelRenderer

void setElementLabelRenderer(ElementLabelRenderer renderer)

Sets the renderer used by this label.

Parameters:

renderer - the new renderer.

See Also:

getElementLabelRenderer()

isUsePatternMarkupToRender

boolean isUsePatternMarkupToRender()

Informs whether the original (saved as pattern) markup is used to render.

The default value is defined by ItsNatDocument.isUsePatternMarkupToRender()

Returns:

true if the original markup is used.

See Also:

setUsePatternMarkupToRender(boolean)

setUsePatternMarkupToRender

void setUsePatternMarkupToRender(boolean value)

Sets whether the original (saved as pattern) markup is used to render.

Parameters:

value - true to enable the use of original markup to render.

See Also:

isUsePatternMarkupToRender()

getContentPatternFragment

org.w3c.dom.DocumentFragment getContentPatternFragment()

Returns the pattern used to render values if isUsePatternMarkupToRender() is true.

Returns:

the pattern used to render values.

setLabelValue

void setLabelValue(java.lang.Object value)

Renders the specified value into the label using the current renderer. If the label does not contains markup is added using the pattern.

Parameters:

value - the value to render.

See Also:

getElementLabelRenderer(), addLabelMarkup(Object), ElementRenderer.render(Object,Object,Element,boolean)

hasLabelMarkup

boolean hasLabelMarkup()

Informs whether this label contains markup.

Returns:

true if this label contains markup.

addLabelMarkup

void addLabelMarkup()

Adds the label pattern markup inside the label element.

See Also:

addLabelMarkup(Object)

addLabelMarkup

void addLabelMarkup(java.lang.Object value)

Adds the label pattern markup inside the label element and renders the specified value.

Parameters:

value - the value to render.

See Also:

setLabelValue(Object)

removeLabelMarkup

void removeLabelMarkup()

Removes the label markup inside the label element.

See Also:

addLabelMarkup()