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

Class AbstractNodeViewElement

java.lang.Object

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

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

All Implemented Interfaces:

HtmlViewElement, MutableViewElement, ViewElement

Direct Known Subclasses:

AbstractTextNodeViewElement, NodeViewElement

public abstract class AbstractNodeViewElement
extends ContainerViewElement
implements HtmlViewElement

Base class for a HtmlViewElement that supports child nodes.

Author:

Arne Vandamme

See Also:

• NodeViewElement
• AbstractVoidNodeViewElement

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	AbstractNodeViewElement(String tagName)

Method Summary

Modifier and Type	Method	Description
AbstractNodeViewElement	addAttributes(Map<String,Object> attributes)
AbstractNodeViewElement	addChild(@NonNull ViewElement element)	Add a child to this container.
AbstractNodeViewElement	addChildren(@NonNull Collection<? extends ViewElement> elements)	Add a collection of children to this container.
AbstractNodeViewElement	addCssClass(String... cssClass)
AbstractNodeViewElement	addFirstChild(@NonNull ViewElement element)	Adds a child as the first one to this container.
AbstractNodeViewElement	apply(@NonNull Consumer<ContainerViewElement> consumer)	Apply a consumer to this container.
<U extends ViewElement> AbstractNodeViewElement	applyUnsafe(@NonNull Consumer<U> consumer)	Apply a consumer to this container.
AbstractNodeViewElement	clearChildren()	Remove all children from this container.
<U> U	get(ViewElement.WitherGetter<?,U> function)	Get a value from the element.
Object	getAttribute(String attributeName)
<V, U extends V> U	getAttribute(String attributeName, Class<V> expectedType)
Map<String,Object>	getAttributes()
String	getHtmlId()
@NonNull String	getTagName()
boolean	hasAttribute(String attributeName)
boolean	hasCssClass(String cssClass)
AbstractNodeViewElement	remove(ViewElement.WitherRemover... functions)	Execute one or more remover functions.
AbstractNodeViewElement	removeAttribute(String attributeName)
AbstractNodeViewElement	removeCssClass(String... cssClass)
protected <V, U extends V> U	returnIfType(Object value, Class<V> elementType)
AbstractNodeViewElement	set(ViewElement.WitherSetter... setters)	Execute one or more setter functions.
AbstractNodeViewElement	setAttribute(String attributeName, Object attributeValue)
AbstractNodeViewElement	setAttributes(@NonNull Map<String,Object> attributes)
AbstractNodeViewElement	setCustomTemplate(String customTemplate)
protected AbstractNodeViewElement	setElementType(String elementType)
AbstractNodeViewElement	setHtmlId(String htmlId)
AbstractNodeViewElement	setName(String name)
protected AbstractNodeViewElement	setTagName(@NonNull String tagName)

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

elementStream, find, find, findAll, findAll, findAll, findOrSelf, findOrSelf, flatStream, getChildren, getCustomTemplate, getElementType, getName, hasChildren, 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

getCustomTemplate, getElementType, getName, matches

Constructor Details

AbstractNodeViewElement

protected AbstractNodeViewElement(String tagName)

Method Details

addCssClass

public AbstractNodeViewElement addCssClass(String... cssClass)

Specified by:

addCssClass in interface HtmlViewElement

hasCssClass

public boolean hasCssClass(String cssClass)

Specified by:

hasCssClass in interface HtmlViewElement

removeCssClass

public AbstractNodeViewElement removeCssClass(String... cssClass)

Specified by:

removeCssClass in interface HtmlViewElement

getAttributes

public Map<String,Object> getAttributes()

Specified by:

getAttributes in interface HtmlViewElement

setAttributes

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

Specified by:

setAttributes in interface HtmlViewElement

setAttribute

public AbstractNodeViewElement setAttribute(String attributeName,
 Object attributeValue)

Specified by:

setAttribute in interface HtmlViewElement

addAttributes

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

Specified by:

addAttributes in interface HtmlViewElement

removeAttribute

public AbstractNodeViewElement removeAttribute(String attributeName)

Specified by:

removeAttribute in interface HtmlViewElement

getAttribute

public Object getAttribute(String attributeName)

Specified by:

getAttribute in interface HtmlViewElement

getAttribute

public <V,
U extends V> U getAttribute(String attributeName,
 Class<V> expectedType)

Specified by:

getAttribute in interface HtmlViewElement

hasAttribute

public boolean hasAttribute(String attributeName)

Specified by:

hasAttribute in interface HtmlViewElement

setName

public AbstractNodeViewElement setName(String name)

Specified by:

setName in interface MutableViewElement

Overrides:

setName in class ContainerViewElement

Returns:

this.

setCustomTemplate

public AbstractNodeViewElement setCustomTemplate(String customTemplate)

Specified by:

setCustomTemplate in interface MutableViewElement

Overrides:

setCustomTemplate in class ContainerViewElement

Returns:

this.

setElementType

protected AbstractNodeViewElement setElementType(String elementType)

Overrides:

setElementType in class ContainerViewElement

Returns:

this.

addChild

public AbstractNodeViewElement addChild(@NonNull
 @NonNull ViewElement element)

Description copied from class: ContainerViewElement

Add a child to this container.

Overrides:

addChild in class ContainerViewElement

Parameters:

element - to add

addChildren

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

Description copied from class: ContainerViewElement

Add a collection of children to this container.

Overrides:

addChildren in class ContainerViewElement

Parameters:

elements - to add

addFirstChild

public AbstractNodeViewElement addFirstChild(@NonNull
 @NonNull ViewElement element)

Description copied from class: ContainerViewElement

Adds a child as the first one to this container.

Overrides:

addFirstChild in class ContainerViewElement

Parameters:

element - to add

clearChildren

public AbstractNodeViewElement clearChildren()

Description copied from class: ContainerViewElement

Remove all children from this container.

Overrides:

clearChildren in class ContainerViewElement

apply

public AbstractNodeViewElement 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 ContainerViewElement

Parameters:

consumer - to execute

applyUnsafe

public <U extends ViewElement>
AbstractNodeViewElement 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 ContainerViewElement

Parameters:

consumer - to execute

returnIfType

protected <V,
U extends V> U returnIfType(Object value,
 Class<V> elementType)

set

public AbstractNodeViewElement 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 ContainerViewElement

Parameters:

setters - to execute

Returns:

self

remove

public AbstractNodeViewElement 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 ContainerViewElement

Parameters:

functions - to execute

Returns:

self

get

public <U> U get(ViewElement.WitherGetter<?,U> function)

Description copied from interface: ViewElement

Get a value from the element. Use ViewElement.WitherGetter.as(Class) for compile time typing. Note that runtime type casting execptions will occur when using the wrong type.

Specified by:

get in interface ViewElement

Type Parameters:

U - type of the expected return value

Parameters:

function - that returns the value

Returns:

value

getTagName

@NonNull
public @NonNull String getTagName()

Specified by:

getTagName in interface HtmlViewElement

setTagName

protected AbstractNodeViewElement setTagName(@NonNull
 @NonNull String tagName)

Returns:

this.

getHtmlId

public String getHtmlId()

Specified by:

getHtmlId in interface HtmlViewElement

setHtmlId

public AbstractNodeViewElement setHtmlId(String htmlId)

Specified by:

setHtmlId in interface HtmlViewElement

Returns:

this.