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

Class ViewElementBuilderSupport<T extends MutableViewElement,SELF extends ViewElementBuilder<T>>

java.lang.Object

com.foreach.across.modules.web.ui.ViewElementBuilderSupport<T,SELF>

Type Parameters:

T - resulting ViewElement

SELF - return type for builder methods

All Implemented Interfaces:

ViewElementBuilder<T>

Direct Known Subclasses:

AbstractVoidNodeViewElementBuilder, ContainerViewElementBuilderSupport, TextViewElementBuilder, ViewElementGeneratorBuilder

public abstract class ViewElementBuilderSupport<T extends MutableViewElement,SELF extends ViewElementBuilder<T>>
extends Object
implements ViewElementBuilder<T>

Base class for a ViewElementBuilder of a MutableViewElement. Provides defaults functionality like configuring a custom templates or a set of post processors.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ViewElementBuilderSupport.ElementOrBuilder	Encapsulates either a ViewElement or ViewElementBuilder for fetching within a ViewElementBuilderContext.

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

ViewElementBuilder.Wither<T extends ViewElementBuilder>

Field Summary

Fields

Modifier and Type	Field	Description
protected String	customTemplate
protected String	name

Constructor Summary

Constructors

Constructor	Description
ViewElementBuilderSupport()

Method Summary

Modifier and Type	Method	Description
protected T	apply(T viewElement, ViewElementBuilderContext builderContext)
final T	build(ViewElementBuilderContext builderContext)	Builds the element using a specific ViewElementBuilderContext.
SELF	configure(Consumer<SELF> consumer)	Execute a consumer that applies some configuration to this builder.
protected abstract T	createElement(ViewElementBuilderContext builderContext)
SELF	customTemplate(String template)
SELF	elementSupplier(Function<ViewElementBuilderContext,? extends T> supplierFunction)	Set a separate supplier which supplies the initial element to which this builder should be applied.
SELF	elementSupplier(Supplier<? extends T> supplier)	Set a separate supplier which supplies the initial element to which this builder should be applied.
SELF	name(String name)
protected final T	postProcess(ViewElementBuilderContext builderContext, T viewElement)
SELF	postProcessor(ViewElementPostProcessor<T> postProcessor)
protected void	registerWebResources(WebResourceRegistry webResourceRegistry)	Method to implement if web resources should be registered.
SELF	with(ViewElement.WitherSetter... setters)	Apply a collection of setters to the element.

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

andThen, build, doWith, map, map, postProcess, postProcess

Field Details

name

protected String name

customTemplate

protected String customTemplate

Constructor Details

ViewElementBuilderSupport

public ViewElementBuilderSupport()

Method Details

elementSupplier

public SELF elementSupplier(Supplier<? extends T> supplier)

Set a separate supplier which supplies the initial element to which this builder should be applied.

Parameters:

supplier - to use instead of calling createElement(ViewElementBuilderContext)

Returns:

current builder

elementSupplier

public SELF elementSupplier(Function<ViewElementBuilderContext,? extends T> supplierFunction)

Set a separate supplier which supplies the initial element to which this builder should be applied.

Parameters:

supplierFunction - to use instead of calling createElement(ViewElementBuilderContext)

Returns:

current builder

with

public SELF with(ViewElement.WitherSetter... setters)

Apply a collection of setters to the element.

name

public SELF name(String name)

customTemplate

public SELF customTemplate(String template)

configure

public SELF configure(Consumer<SELF> consumer)

Execute a consumer that applies some configuration to this builder. Useful if you do not want to break a fluent api style of coding.

The consumer is called immediately if it is not null.

postProcessor

public SELF postProcessor(ViewElementPostProcessor<T> postProcessor)

build

public final T build(ViewElementBuilderContext builderContext)

Builds the element using a specific ViewElementBuilderContext.

Specified by:

build in interface ViewElementBuilder<T extends MutableViewElement>

Parameters:

builderContext - provides the context for this build event

Returns:

element created and post processed

createElement

protected abstract T createElement(ViewElementBuilderContext builderContext)

registerWebResources

protected void registerWebResources(WebResourceRegistry webResourceRegistry)

Method to implement if web resources should be registered. Will only be called if there is a WebResourceRegistry present in the current (thread local) context.

Parameters:

webResourceRegistry - to add entries to

apply

protected T apply(T viewElement,
 ViewElementBuilderContext builderContext)

postProcess

protected final T postProcess(ViewElementBuilderContext builderContext,
 T viewElement)