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

Class NodeViewElement

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.NodeViewElement

All Implemented Interfaces:

HtmlViewElement, MutableViewElement, ViewElement

public class NodeViewElement
extends AbstractNodeViewElement

Represents a generic node (html element). Supports tag, set of attributes and child elements.

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

Constructor	Description
NodeViewElement(String tagName)
NodeViewElement(String name, String tagName)

Method Summary

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

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, 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

NodeViewElement

public NodeViewElement(String name,
 String tagName)

NodeViewElement

public NodeViewElement(String tagName)

Method Details

setTagName

public NodeViewElement setTagName(String tagName)

Overrides:

setTagName in class AbstractNodeViewElement

Returns:

this.

setHtmlId

public NodeViewElement setHtmlId(String htmlId)

Specified by:

setHtmlId in interface HtmlViewElement

Overrides:

setHtmlId in class AbstractNodeViewElement

Returns:

this.

addCssClass

public NodeViewElement addCssClass(String... cssClass)

Specified by:

addCssClass in interface HtmlViewElement

Overrides:

addCssClass in class AbstractNodeViewElement

removeCssClass

public NodeViewElement removeCssClass(String... cssClass)

Specified by:

removeCssClass in interface HtmlViewElement

Overrides:

removeCssClass in class AbstractNodeViewElement

setAttributes

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

Specified by:

setAttributes in interface HtmlViewElement

Overrides:

setAttributes in class AbstractNodeViewElement

setAttribute

public NodeViewElement setAttribute(String attributeName,
 Object attributeValue)

Specified by:

setAttribute in interface HtmlViewElement

Overrides:

setAttribute in class AbstractNodeViewElement

addAttributes

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

Specified by:

addAttributes in interface HtmlViewElement

Overrides:

addAttributes in class AbstractNodeViewElement

removeAttribute

public NodeViewElement removeAttribute(String attributeName)

Specified by:

removeAttribute in interface HtmlViewElement

Overrides:

removeAttribute in class AbstractNodeViewElement

setName

public NodeViewElement setName(String name)

Specified by:

setName in interface MutableViewElement

Overrides:

setName in class AbstractNodeViewElement

Returns:

this.

setCustomTemplate

public NodeViewElement setCustomTemplate(String customTemplate)

Specified by:

setCustomTemplate in interface MutableViewElement

Overrides:

setCustomTemplate in class AbstractNodeViewElement

Returns:

this.

setElementType

protected NodeViewElement setElementType(String elementType)

Overrides:

setElementType in class AbstractNodeViewElement

Returns:

this.

addChild

public NodeViewElement 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 NodeViewElement 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 NodeViewElement 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 NodeViewElement clearChildren()

Description copied from class: ContainerViewElement

Remove all children from this container.

Overrides:

clearChildren in class AbstractNodeViewElement

apply

public NodeViewElement 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

set

public NodeViewElement 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 NodeViewElement 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

applyUnsafe

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