Package com.foreach.across.modules.web.ui.elements

Class TextViewElement

java.lang.Object

com.foreach.across.modules.web.ui.ViewElementSupport

com.foreach.across.modules.web.ui.elements.TextViewElement

All Implemented Interfaces:

ConfigurableTextViewElement, MutableViewElement, ViewElement, ViewElement.WitherSetter<ViewElement>

public class TextViewElement
extends ViewElementSupport
implements ConfigurableTextViewElement, ViewElement.WitherSetter<ViewElement>

A simple text item.

Nested Class Summary

Nested classes/interfaces inherited from interface com.foreach.across.modules.web.ui.MutableViewElement

MutableViewElement.Functions

Nested classes/interfaces inherited from interface com.foreach.across.modules.web.ui.ViewElement

ViewElement.Wither<T extends ViewElement>, ViewElement.WitherGetter<T extends ViewElement,U>, ViewElement.WitherRemover<T extends ViewElement>, ViewElement.WitherSetter<T extends ViewElement>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ELEMENT_TYPE

Constructor Summary

Constructors

Constructor	Description
TextViewElement()
TextViewElement(String text)
TextViewElement(String text, boolean escapeXml)
TextViewElement(String name, String text)
TextViewElement(String name, String text, boolean escapeXml)

Method Summary

Modifier and Type	Method	Description
void	applyTo(ViewElement target)	If the target implements ConfigurableTextViewElement then the text property will be copied.
String	getText()
static TextViewElement	html(String html)	Alias to xml(String).
boolean	isEscapeXml()
TextViewElement	remove(ViewElement.WitherRemover... functions)	Execute one or more remover functions.
TextViewElement	set(ViewElement.WitherSetter... setters)	Execute one or more setter functions.
TextViewElement	setCustomTemplate(String customTemplate)
TextViewElement	setEscapeXml(boolean escapeXml)
TextViewElement	setName(String name)
TextViewElement	setText(String text)
static TextViewElement	text(String text)	Factory method to create a TextViewElement for plain xml-escaped text.
static TextViewElement	xml(String xml)	Factory method to create a TextViewElement for XML content (non-escaped).

Methods inherited from class com.foreach.across.modules.web.ui.ViewElementSupport

getCustomTemplate, getElementType, getName, setElementType

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.foreach.across.modules.web.ui.ViewElement

get, getCustomTemplate, getElementType, getName, matches

Field Details

ELEMENT_TYPE

public static final String ELEMENT_TYPE

See Also:

• Constant Field Values

Constructor Details

TextViewElement

public TextViewElement()

TextViewElement

public TextViewElement(String text)

TextViewElement

public TextViewElement(String name,
 String text)

TextViewElement

public TextViewElement(String text,
 boolean escapeXml)

TextViewElement

public TextViewElement(String name,
 String text,
 boolean escapeXml)

Method Details

setName

public TextViewElement setName(String name)

Specified by:

setName in interface MutableViewElement

Overrides:

setName in class ViewElementSupport

setCustomTemplate

public TextViewElement setCustomTemplate(String customTemplate)

Specified by:

setCustomTemplate in interface MutableViewElement

Overrides:

setCustomTemplate in class ViewElementSupport

set

public TextViewElement set(ViewElement.WitherSetter... setters)

Description copied from interface: ViewElement

Execute one or more setter functions.

Specified by:

set in interface MutableViewElement

Specified by:

set in interface ViewElement

Overrides:

set in class ViewElementSupport

Parameters:

setters - to execute

Returns:

self

remove

public TextViewElement remove(ViewElement.WitherRemover... functions)

Description copied from interface: ViewElement

Execute one or more remover functions. A remover is defined as a separate interface so implementations can both implement setter and remover at the same time.

Specified by:

remove in interface MutableViewElement

Specified by:

remove in interface ViewElement

Overrides:

remove in class ViewElementSupport

Parameters:

functions - to execute

Returns:

self

applyTo

public void applyTo(ViewElement target)

If the target implements ConfigurableTextViewElement then the text property will be copied. Else if the target is a ContainerViewElement the element itself will be added as the first child.

Specified by:

applyTo in interface ViewElement.WitherSetter<ViewElement>

text

public static TextViewElement text(String text)

Factory method to create a TextViewElement for plain xml-escaped text.

Parameters:

text - content

Returns:

element

html

public static TextViewElement html(String html)

Alias to xml(String).

Parameters:

html - content

Returns:

element

xml

public static TextViewElement xml(String xml)

Factory method to create a TextViewElement for XML content (non-escaped).

Parameters:

xml - content

Returns:

element

isEscapeXml

public boolean isEscapeXml()

getText

public String getText()

Specified by:

getText in interface ConfigurableTextViewElement

setEscapeXml

public TextViewElement setEscapeXml(boolean escapeXml)

Returns:

this.

setText

public TextViewElement setText(String text)

Specified by:

setText in interface ConfigurableTextViewElement

Returns:

this.