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

Class TemplateViewElement

java.lang.Object

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

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

All Implemented Interfaces:

MutableViewElement, ViewElement

public class TemplateViewElement
extends ViewElementSupport

A ViewElement that simply renders as a custom template. If no ViewElementSupport.getCustomTemplate() is defined, this element will output nothing.

Author:

Arne Vandamme

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
TemplateViewElement()
TemplateViewElement(String customTemplate)
TemplateViewElement(String name, String customTemplate)

Method Summary

Modifier and Type	Method	Description
TemplateViewElement	addAttributes(Map<String,Object> attributes)
Object	getAttribute(String attributeName)
<V> V	getAttribute(String attributeName, Class<V> expectedType)
Map<String,Object>	getAttributes()
boolean	hasAttribute(String attributeName)
TemplateViewElement	remove(ViewElement.WitherRemover... functions)	Execute one or more remover functions.
TemplateViewElement	removeAttribute(String attributeName)
protected <V> V	returnIfType(Object value, Class<V> elementType)
TemplateViewElement	set(ViewElement.WitherSetter... setters)	Execute one or more setter functions.
TemplateViewElement	setAttribute(String attributeName, Object attributeValue)
TemplateViewElement	setAttributes(@NonNull Map<String,Object> attributes)
TemplateViewElement	setElementType(String elementType)

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

getCustomTemplate, getElementType, getName, setCustomTemplate, setName

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

Field Details

ELEMENT_TYPE

public static final String ELEMENT_TYPE

See Also:

• Constant Field Values

Constructor Details

TemplateViewElement

public TemplateViewElement(String name,
 String customTemplate)

TemplateViewElement

public TemplateViewElement(String customTemplate)

TemplateViewElement

public TemplateViewElement()

Method Details

setElementType

public TemplateViewElement setElementType(String elementType)

Overrides:

setElementType in class ViewElementSupport

getAttributes

public Map<String,Object> getAttributes()

setAttributes

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

setAttribute

public TemplateViewElement setAttribute(String attributeName,
 Object attributeValue)

addAttributes

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

removeAttribute

public TemplateViewElement removeAttribute(String attributeName)

getAttribute

public Object getAttribute(String attributeName)

getAttribute

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

hasAttribute

public boolean hasAttribute(String attributeName)

returnIfType

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

set

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