Uses of Interface
com.foreach.across.modules.web.ui.ViewElement

Packages that use ViewElement

Package	Description
com.foreach.across.modules.web.thymeleaf
com.foreach.across.modules.web.ui
com.foreach.across.modules.web.ui.elements
com.foreach.across.modules.web.ui.elements.builder
com.foreach.across.modules.web.ui.elements.support
com.foreach.across.modules.web.ui.thymeleaf

Uses of ViewElement in com.foreach.across.modules.web.thymeleaf

Methods in com.foreach.across.modules.web.thymeleaf with parameters of type ViewElement

Modifier and Type	Method	Description
void	ThymeleafModelBuilder.addViewElement(ViewElement viewElement)	Add the element to the model.
org.thymeleaf.model.IModel	ThymeleafModelBuilder.createViewElementModel(ViewElement viewElement)	Create a separate IModel for a ViewElement.
String	HtmlIdStore.retrieveHtmlId(org.thymeleaf.context.ITemplateContext context, ViewElement control)	Retrieve the generated id for a ViewElement.
String	ThymeleafModelBuilder.retrieveHtmlId(ViewElement viewElement)	Get a unique id for the specific element.

Uses of ViewElement in com.foreach.across.modules.web.ui

Classes in com.foreach.across.modules.web.ui with type parameters of type ViewElement

Modifier and Type	Class	Description
final class	DefaultViewElementPostProcessor<T extends ViewElement>	Implementation that looks for a collection of ViewElementPostProcessors on the ViewElementBuilderContext and applies all of them.
static class	ViewElement.Wither<T extends ViewElement>	A wrapper for any type of ViewElement which allows the use of separate functions to perform the actions.
static interface	ViewElement.WitherGetter<T extends ViewElement,U>	Function that fetches a value from a view element and optionally returns it as a specific type for compile time checking.
static interface	ViewElement.WitherRemover<T extends ViewElement>	Function that modifies a view element by removing values.
static interface	ViewElement.WitherSetter<T extends ViewElement>	Function that modifies a view element by setting or adding values.
interface	ViewElementBuilder<T extends ViewElement>	Base interface to create a single ViewElement instance.
interface	ViewElementPostProcessor<T extends ViewElement>	General purpose interface for post-processing a ViewElement.

Subinterfaces of ViewElement in com.foreach.across.modules.web.ui

Modifier and Type	Interface	Description
interface	MutableViewElement

Classes in com.foreach.across.modules.web.ui that implement ViewElement

Modifier and Type	Class	Description
class	ViewElementSupport

Methods in com.foreach.across.modules.web.ui with type parameters of type ViewElement

Modifier and Type	Method	Description
<ITEM, VIEW_ELEMENT extends ViewElement> ViewElementGeneratorBuilder<ITEM,VIEW_ELEMENT>	StandardViewElementBuilderFactory.generator(Class<ITEM> itemClass, Class<VIEW_ELEMENT> viewElementClass)
<ITEM, VIEW_ELEMENT extends ViewElement> ViewElementGeneratorBuilder<ITEM,VIEW_ELEMENT>	ViewElementBuilderFactory.generator(Class<ITEM> itemClass, Class<VIEW_ELEMENT> viewElementClass)
default <U extends ViewElement> ViewElementBuilder<U>	ViewElementBuilder.map(@NonNull BiFunction<ViewElementBuilderContext,T,U> mappingFunction)	Map the ViewElement that this builder returns to another type.
default <U extends ViewElement> ViewElementBuilder<U>	ViewElementBuilder.map(@NonNull Function<T,U> mappingFunction)	Map the ViewElement that this builder returns to another type.
static <U extends ViewElement> ViewElementBuilder<U>	ViewElementBuilder.of(Function<ViewElementBuilderContext,U> supplier)
static <U extends ViewElement> ViewElementBuilder<U>	ViewElementBuilder.of(Supplier<U> supplier)
static <U extends ViewElement> Predicate<U>	ViewElement.predicateFor(Class<U> elementType, Predicate<U> predicate)	Short-hand for creating an anonymous typed predicate, can be used to inline type predicate creation.
static <U extends ViewElement> ViewElement.Wither<U>	ViewElement.with(U element)	Create a ViewElement.Wither wrapper for an element, which allows for a more descriptive, fluent configuration approach by using pre-defined lambdas.
static <U extends ViewElement> ViewElement.WitherSetter<U>	MutableViewElement.Functions.witherFor(Class<U> elementType, ViewElement.WitherSetter<U> setter)	Short-hand for creating an anonymous typed wither setter, can be used to inline create setters.

Methods in com.foreach.across.modules.web.ui that return ViewElement

Modifier and Type	Method	Description
ViewElement	ViewElementBuilderSupport.ElementOrBuilder.get(ViewElementBuilderContext builderContext)
default ViewElement	ViewElement.remove(ViewElement.WitherRemover... functions)	Execute one or more remover functions.
default ViewElement	ViewElement.set(ViewElement.WitherSetter... setters)	Execute one or more setter functions.

Methods in com.foreach.across.modules.web.ui with parameters of type ViewElement

Modifier and Type	Method	Description
void	DefaultViewElementPostProcessor.postProcess(ViewElementBuilderContext builderContext, ViewElement element)
static ViewElementBuilderSupport.ElementOrBuilder	ViewElementBuilderSupport.ElementOrBuilder.wrap(ViewElement viewElement)

Uses of ViewElement in com.foreach.across.modules.web.ui.elements

Classes in com.foreach.across.modules.web.ui.elements with type parameters of type ViewElement

Modifier and Type	Class	Description
class	ViewElementGenerator<ITEM,VIEW_ELEMENT extends ViewElement>	Represents a collection of ViewElement instances that are generated based on a template or callback method and an input item.
static interface	ViewElementGenerator.CreationCallback<T,U extends ViewElement>	Callback interface for customizing the generated ViewElement.

Subinterfaces of ViewElement in com.foreach.across.modules.web.ui.elements

Modifier and Type	Interface	Description
interface	ConfigurableTextViewElement	Interface extending a ViewElement with a settable text property.
interface	HtmlViewElement	Adds base properties for a HTML node, like css class and html id support.

Classes in com.foreach.across.modules.web.ui.elements that implement ViewElement

Modifier and Type	Class	Description
class	AbstractNodeViewElement	Base class for a HtmlViewElement that supports child nodes.
class	AbstractTextNodeViewElement	Base class that extends AbstractNodeViewElement with the ConfigurableTextViewElement.
class	AbstractVoidNodeViewElement	Base class for a single configurable node that supports attributes but no child nodes.
class	ContainerViewElement	A container is a named collection of elements (ContainerViewElement.getChildren() that allows configuration of a custom template for rendering.
class	NodeViewElement	Represents a generic node (html element).
class	TemplateViewElement	A ViewElement that simply renders as a custom template.
class	TextViewElement	A simple text item.
class	ViewElementGenerator<ITEM,VIEW_ELEMENT extends ViewElement>	Represents a collection of ViewElement instances that are generated based on a template or callback method and an input item.
class	VoidNodeViewElement	A void node is a node that has attributes but contains no children.

Methods in com.foreach.across.modules.web.ui.elements with type parameters of type ViewElement

Modifier and Type	Method	Description
<U extends ViewElement> AbstractNodeViewElement	AbstractNodeViewElement.applyUnsafe(@NonNull Consumer<U> consumer)
<U extends ViewElement> AbstractTextNodeViewElement	AbstractTextNodeViewElement.applyUnsafe(@NonNull Consumer<U> consumer)
<U extends ViewElement> ContainerViewElement	ContainerViewElement.applyUnsafe(@NonNull Consumer<U> consumer)	Deprecated. use with(ViewElement) instead
<U extends ViewElement> NodeViewElement	NodeViewElement.applyUnsafe(@NonNull Consumer<U> consumer)
<V extends ViewElement> Optional<V>	ContainerViewElement.find(String elementName, Class<V> requiredType)	Find the first child element with the given name that is also of the required type.
<V extends ViewElement> Stream<V>	ContainerViewElement.findAll(Class<V> requiredType)	Find all elements in the container that are of the required type.
<V extends ViewElement> Stream<V>	ContainerViewElement.findAll(Class<V> requiredType, Predicate<V> predicate)	Find all elements in the container that are of the required type and match the additional predicate.
<V extends ViewElement> Optional<V>	ContainerViewElement.findOrSelf(String elementName, Class<V> requiredType)	Find the first element with the given name that is also of the required type.

Methods in com.foreach.across.modules.web.ui.elements that return types with arguments of type ViewElement

Modifier and Type	Method	Description
Stream<ViewElement>	ContainerViewElement.elementStream()	Get the stream of all ViewElement instances this container represents (excluding itself).
Optional<ViewElement>	ContainerViewElement.find(String elementName)	Find the first child element with the given name in the container.
Stream<ViewElement>	ContainerViewElement.findAll(Predicate<ViewElement> predicate)	Find all elements in the container that are of the required type and match the additional predicate.
Optional<ViewElement>	ContainerViewElement.findOrSelf(String name)	Find the first element with the given name in the container.
Stream<ViewElement>	ContainerViewElement.flatStream()	Creates a flattened stream of all elements in the container.
List<ViewElement>	AbstractTextNodeViewElement.getChildren()
List<ViewElement>	ContainerViewElement.getChildren()	Get the list of direct children this container represents.
Stream<ViewElement>	ContainerViewElement.removeAllFromTree(String... elementNames)	Removes all elements with the given names from the tree.
Optional<ViewElement>	ContainerViewElement.removeFromTree(String elementName)	Remove the first element with the given name from the container or any of its children.

Methods in com.foreach.across.modules.web.ui.elements with parameters of type ViewElement

Modifier and Type	Method	Description
AbstractNodeViewElement	AbstractNodeViewElement.addChild(@NonNull ViewElement element)
AbstractTextNodeViewElement	AbstractTextNodeViewElement.addChild(@NonNull ViewElement element)
ContainerViewElement	ContainerViewElement.addChild(@NonNull ViewElement element)	Add a child to this container.
NodeViewElement	NodeViewElement.addChild(@NonNull ViewElement element)
AbstractNodeViewElement	AbstractNodeViewElement.addFirstChild(@NonNull ViewElement element)
AbstractTextNodeViewElement	AbstractTextNodeViewElement.addFirstChild(@NonNull ViewElement element)
ContainerViewElement	ContainerViewElement.addFirstChild(@NonNull ViewElement element)	Adds a child as the first one to this container.
NodeViewElement	NodeViewElement.addFirstChild(@NonNull ViewElement element)
void	TextViewElement.applyTo(ViewElement target)	If the target implements ConfigurableTextViewElement then the text property will be copied.
static ViewElement.WitherSetter<ContainerViewElement>	HtmlViewElement.Functions.children(ViewElement... elements)	Add children to a container element.
ContainerViewElement	HtmlViewElements.container(ViewElement... childElements)
boolean	ContainerViewElement.removeChild(ViewElement element)	Remove a direct child from this container.
boolean	ContainerViewElement.removeFromTree(ViewElement element)	Remove the given element from the container.

Method parameters in com.foreach.across.modules.web.ui.elements with type arguments of type ViewElement

Modifier and Type	Method	Description
AbstractNodeViewElement	AbstractNodeViewElement.addChildren(@NonNull Collection<? extends ViewElement> elements)
AbstractTextNodeViewElement	AbstractTextNodeViewElement.addChildren(@NonNull Collection<? extends ViewElement> elements)
ContainerViewElement	ContainerViewElement.addChildren(@NonNull Collection<? extends ViewElement> elements)	Add a collection of children to this container.
NodeViewElement	NodeViewElement.addChildren(@NonNull Collection<? extends ViewElement> elements)
Stream<ViewElement>	ContainerViewElement.findAll(Predicate<ViewElement> predicate)	Find all elements in the container that are of the required type and match the additional predicate.

Uses of ViewElement in com.foreach.across.modules.web.ui.elements.builder

Classes in com.foreach.across.modules.web.ui.elements.builder with type parameters of type ViewElement

Modifier and Type	Class	Description
class	ViewElementGeneratorBuilder<ITEM,VIEW_ELEMENT extends ViewElement>

Methods in com.foreach.across.modules.web.ui.elements.builder with parameters of type ViewElement

Modifier and Type	Method	Description
ContainerViewElementBuilder	ContainerViewElementBuilder.add(ViewElement... viewElements)
SELF	ContainerViewElementBuilderSupport.add(ViewElement... viewElements)
ContainerViewElementBuilder	ContainerViewElementBuilder.addFirst(ViewElement... viewElements)
SELF	ContainerViewElementBuilderSupport.addFirst(ViewElement... viewElements)

Uses of ViewElement in com.foreach.across.modules.web.ui.elements.support

Methods in com.foreach.across.modules.web.ui.elements.support with type parameters of type ViewElement

Modifier and Type	Method	Description
static <V extends ViewElement> Optional<V>	ContainerViewElementUtils.find(ContainerViewElement container, String elementName, Class<V> requiredType)	Find the first element with the given name that is also of the required type.
static <V extends ViewElement> Stream<V>	ContainerViewElementUtils.findAll(ContainerViewElement container, Class<V> requiredType)	Find all elements in the container that are of the required type.
static <V extends ViewElement> Stream<V>	ContainerViewElementUtils.findAll(ContainerViewElement container, Class<V> requiredType, Predicate<V> predicate)	Find all elements in the container that are of the required type and match the additional predicate.
static <V extends ViewElement> Optional<V>	ContainerViewElementUtils.findOrSelf(ContainerViewElement container, String elementName, Class<V> requiredType)	Find the first element with the given name that is also of the required type.
static <V extends ViewElement> boolean	ContainerViewElementUtils.replace(ContainerViewElement container, String elementName, Class<V> requiredType, Function<V,? extends ViewElement> replacementFunction)	Replace an element in the container hierarchy by another element.

Methods in com.foreach.across.modules.web.ui.elements.support that return types with arguments of type ViewElement

Modifier and Type	Method	Description
static Optional<ViewElement>	ContainerViewElementUtils.find(ContainerViewElement container, String elementName)	Find the first element with the given name in the container.
static Stream<ViewElement>	ContainerViewElementUtils.findAll(@NonNull ContainerViewElement container, @NonNull Predicate<ViewElement> predicate)	Find all elements in the container that match the predicate.
static Optional<ViewElement>	ContainerViewElementUtils.findOrSelf(ContainerViewElement container, String elementName)	Find the first element with the given name in the container.
static Stream<ViewElement>	ContainerViewElementUtils.flatStream(ContainerViewElement container)	Creates a flattened stream of all elements in the container.
static Optional<ViewElement>	ContainerViewElementUtils.remove(ContainerViewElement container, String elementName)	Remove the first element with the given name from the container or any of its children.
static Stream<ViewElement>	ContainerViewElementUtils.removeAll(ContainerViewElement container, String... elementNames)	Remove all elements with that name from the tree.

Methods in com.foreach.across.modules.web.ui.elements.support with parameters of type ViewElement

Modifier and Type	Method	Description
static Optional<ContainerViewElement>	ContainerViewElementUtils.findParent(ContainerViewElement container, ViewElement child)	Find the parent ContainerViewElement of the child element.
static boolean	ContainerViewElementUtils.move(ContainerViewElement container, ViewElement elementToMove, ContainerViewElement newParent)	Moves an element to a new parent container.
static boolean	ContainerViewElementUtils.move(ContainerViewElement container, ViewElement elementToMove, String newParent)	Attempts to move an element to a new parent that is part of the container.
static boolean	ContainerViewElementUtils.remove(ContainerViewElement container, ViewElement element)	Remove the given element from the container.
static boolean	ContainerViewElementUtils.replace(ContainerViewElement container, ViewElement elementToReplace, ViewElement replacement)	Replace an element in the container hierarchy by another element.

Method parameters in com.foreach.across.modules.web.ui.elements.support with type arguments of type ViewElement

Modifier and Type	Method	Description
static Stream<ViewElement>	ContainerViewElementUtils.findAll(@NonNull ContainerViewElement container, @NonNull Predicate<ViewElement> predicate)	Find all elements in the container that match the predicate.
static <V extends ViewElement> boolean	ContainerViewElementUtils.replace(ContainerViewElement container, String elementName, Class<V> requiredType, Function<V,? extends ViewElement> replacementFunction)	Replace an element in the container hierarchy by another element.
static boolean	ContainerViewElementUtils.replace(ContainerViewElement container, String elementName, UnaryOperator<ViewElement> replacementFunction)	Replace an element in the container hierarchy by another element.
static void	ContainerViewElementUtils.sort(List<ViewElement> viewElements, String... elementNames)	Sorts the list of view elements according to the element names passed in.
static void	ContainerViewElementUtils.sortRecursively(List<ViewElement> viewElements, String... elementNames)	Recursively sorts the list of elements according to the order specified by the element names passed in.

Uses of ViewElement in com.foreach.across.modules.web.ui.thymeleaf

Classes in com.foreach.across.modules.web.ui.thymeleaf with type parameters of type ViewElement

Modifier and Type	Interface	Description
interface	ViewElementModelWriter<T extends ViewElement>	API for creating and writing the model for a single ViewElement.

Methods in com.foreach.across.modules.web.ui.thymeleaf that return types with arguments of type ViewElement

Modifier and Type	Method	Description
ViewElementModelWriter<ViewElement>	ViewElementModelWriterRegistry.getModelWriter(@NonNull ViewElement viewElement)	Finds the most appropriate ViewElementModelWriter: first attempts to find a writer registered to that specific class, second looks for the element type.

Methods in com.foreach.across.modules.web.ui.thymeleaf with parameters of type ViewElement

Modifier and Type	Method	Description
ViewElementModelWriter<ViewElement>	ViewElementModelWriterRegistry.getModelWriter(@NonNull ViewElement viewElement)	Finds the most appropriate ViewElementModelWriter: first attempts to find a writer registered to that specific class, second looks for the element type.

Method parameters in com.foreach.across.modules.web.ui.thymeleaf with type arguments of type ViewElement

Modifier and Type	Method	Description
void	ViewElementModelWriterRegistry.registerModelWriter(Class<? extends ViewElement> viewElementClass, ViewElementModelWriter builder)