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

Class AbstractTextNodeViewElement

java.lang.Object

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

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

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

All Implemented Interfaces:

ConfigurableTextViewElement, HtmlViewElement, MutableViewElement, ViewElement

public abstract class AbstractTextNodeViewElement
extends AbstractNodeViewElement
implements ConfigurableTextViewElement

Base class that extends AbstractNodeViewElement with the ConfigurableTextViewElement. If setText(String) is set, a TextViewElement will be added.

Since:

2.0.0

Author:

Arne Vandamme

Nested Class Summary

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

HtmlViewElement.Functions

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 inherited from class com.foreach.across.modules.web.ui.elements.ContainerViewElement

ELEMENT_TYPE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractTextNodeViewElement(String tagName)

Method Summary

Modifier and Type	Method	Description
AbstractTextNodeViewElement	addAttributes(Map<String,Object> attributes)
AbstractTextNodeViewElement	addChild(@NonNull ViewElement element)	Add a child to this container.
AbstractTextNodeViewElement	addChildren(@NonNull Collection<? extends ViewElement> elements)	Add a collection of children to this container.
AbstractTextNodeViewElement	addCssClass(String... cssClass)
AbstractTextNodeViewElement	addFirstChild(@NonNull ViewElement element)	Adds a child as the first one to this container.
AbstractTextNodeViewElement	apply(@NonNull Consumer<ContainerViewElement> consumer)	Apply a consumer to this container.
<U extends ViewElement> AbstractTextNodeViewElement	applyUnsafe(@NonNull Consumer<U> consumer)	Apply a consumer to this container.
AbstractTextNodeViewElement	clearChildren()	Remove all children from this container.
List<ViewElement>	getChildren()	Get the list of direct children this container represents.
String	getText()	Configure a simple text body for the alert.
boolean	hasChildren()
AbstractTextNodeViewElement	remove(ViewElement.WitherRemover... functions)	Execute one or more remover functions.
AbstractTextNodeViewElement	removeAttribute(String attributeName)
AbstractTextNodeViewElement	removeCssClass(String... cssClass)
AbstractTextNodeViewElement	set(ViewElement.WitherSetter... setters)	Execute one or more setter functions.
AbstractTextNodeViewElement	setAttribute(String attributeName, Object attributeValue)
AbstractTextNodeViewElement	setAttributes(@NonNull Map<String,Object> attributes)
AbstractTextNodeViewElement	setCustomTemplate(String customTemplate)
protected AbstractTextNodeViewElement	setElementType(String elementType)
AbstractTextNodeViewElement	setHtmlId(String htmlId)
AbstractTextNodeViewElement	setName(String name)
protected AbstractTextNodeViewElement	setTagName(@NonNull String tagName)
AbstractTextNodeViewElement	setText(String text)	Configure a simple text body for the alert.

Methods inherited from class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

get, getAttribute, getAttribute, getAttributes, getHtmlId, getTagName, hasAttribute, hasCssClass, returnIfType

Methods inherited from class com.foreach.across.modules.web.ui.elements.ContainerViewElement

elementStream, find, find, findAll, findAll, findAll, findOrSelf, findOrSelf, flatStream, getCustomTemplate, getElementType, getName, removeAllFromTree, removeChild, removeFromTree, removeFromTree

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

Constructor Details

AbstractTextNodeViewElement

protected AbstractTextNodeViewElement(String tagName)

Method Details

setTagName

protected AbstractTextNodeViewElement setTagName(@NonNull
 @NonNull String tagName)

Overrides:

setTagName in class AbstractNodeViewElement

Returns:

this.

setHtmlId

public AbstractTextNodeViewElement setHtmlId(String htmlId)

Specified by:

setHtmlId in interface HtmlViewElement

Overrides:

setHtmlId in class AbstractNodeViewElement

Returns:

this.

addCssClass

public AbstractTextNodeViewElement addCssClass(String... cssClass)

Specified by:

addCssClass in interface HtmlViewElement

Overrides:

addCssClass in class AbstractNodeViewElement

removeCssClass

public AbstractTextNodeViewElement removeCssClass(String... cssClass)

Specified by:

removeCssClass in interface HtmlViewElement

Overrides:

removeCssClass in class AbstractNodeViewElement

setAttributes

public AbstractTextNodeViewElement setAttributes(@NonNull
 @NonNull Map<String,Object> attributes)

Specified by:

setAttributes in interface HtmlViewElement

Overrides:

setAttributes in class AbstractNodeViewElement

setAttribute

public AbstractTextNodeViewElement setAttribute(String attributeName,
 Object attributeValue)

Specified by:

setAttribute in interface HtmlViewElement

Overrides:

setAttribute in class AbstractNodeViewElement

addAttributes

public AbstractTextNodeViewElement addAttributes(Map<String,Object> attributes)

Specified by:

addAttributes in interface HtmlViewElement

Overrides:

addAttributes in class AbstractNodeViewElement

removeAttribute

public AbstractTextNodeViewElement removeAttribute(String attributeName)

Specified by:

removeAttribute in interface HtmlViewElement

Overrides:

removeAttribute in class AbstractNodeViewElement

setName

public AbstractTextNodeViewElement setName(String name)

Specified by:

setName in interface MutableViewElement

Overrides:

setName in class AbstractNodeViewElement

Returns:

this.

setCustomTemplate

public AbstractTextNodeViewElement setCustomTemplate(String customTemplate)

Specified by:

setCustomTemplate in interface MutableViewElement

Overrides:

setCustomTemplate in class AbstractNodeViewElement

Returns:

this.

setElementType

protected AbstractTextNodeViewElement setElementType(String elementType)

Overrides:

setElementType in class AbstractNodeViewElement

Returns:

this.

addChild

public AbstractTextNodeViewElement addChild(@NonNull
 @NonNull ViewElement element)

Description copied from class: ContainerViewElement

Add a child to this container.

Overrides:

addChild in class AbstractNodeViewElement

Parameters:

element - to add

addChildren

public AbstractTextNodeViewElement addChildren(@NonNull
 @NonNull Collection<? extends ViewElement> elements)

Description copied from class: ContainerViewElement

Add a collection of children to this container.

Overrides:

addChildren in class AbstractNodeViewElement

Parameters:

elements - to add

addFirstChild

public AbstractTextNodeViewElement addFirstChild(@NonNull
 @NonNull ViewElement element)

Description copied from class: ContainerViewElement

Adds a child as the first one to this container.

Overrides:

addFirstChild in class AbstractNodeViewElement

Parameters:

element - to add

clearChildren

public AbstractTextNodeViewElement clearChildren()

Description copied from class: ContainerViewElement

Remove all children from this container.

Overrides:

clearChildren in class AbstractNodeViewElement

apply

public AbstractTextNodeViewElement apply(@NonNull
 @NonNull Consumer<ContainerViewElement> consumer)

Description copied from class: ContainerViewElement

Apply a consumer to this container. Useful for providing extensions that wish to provide actions on the container itself.

Overrides:

apply in class AbstractNodeViewElement

Parameters:

consumer - to execute

applyUnsafe

public <U extends ViewElement>
AbstractTextNodeViewElement applyUnsafe(@NonNull
 @NonNull Consumer<U> consumer)

Description copied from class: ContainerViewElement

Apply a consumer to this container. Useful for providing extensions that wish to provide actions on the container itself.

This method allows you to pass any Consumer for a generic ViewElement. Note that if you pass a consumer for a type that is not compatible with ContainerViewElement, you will receive class cast exceptions at runtime, hence the unsafe.

Overrides:

applyUnsafe in class AbstractNodeViewElement

Parameters:

consumer - to execute

hasChildren

public boolean hasChildren()

Overrides:

hasChildren in class ContainerViewElement

Returns:

true if this container has child elements

getChildren

public List<ViewElement> getChildren()

Description copied from class: ContainerViewElement

Get the list of direct children this container represents.

Overrides:

getChildren in class ContainerViewElement

Returns:

list of child elements this container represents

set

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

Description copied from interface: ViewElement

Execute one or more setter functions.

Specified by:

set in interface HtmlViewElement

Specified by:

set in interface MutableViewElement

Specified by:

set in interface ViewElement

Overrides:

set in class AbstractNodeViewElement

Parameters:

setters - to execute

Returns:

self

remove

public AbstractTextNodeViewElement 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 HtmlViewElement

Specified by:

remove in interface MutableViewElement

Specified by:

remove in interface ViewElement

Overrides:

remove in class AbstractNodeViewElement

Parameters:

functions - to execute

Returns:

self

getText

public String getText()

Configure a simple text body for the alert. Additional children will be after.

Specified by:

getText in interface ConfigurableTextViewElement

setText

public AbstractTextNodeViewElement setText(String text)

Configure a simple text body for the alert. Additional children will be after.

Specified by:

setText in interface ConfigurableTextViewElement

Returns:

this.