Package com.foreach.across.modules.bootstrapui.components.builder

Class DefaultNavComponentBuilder

java.lang.Object

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

com.foreach.across.modules.web.ui.elements.builder.ContainerViewElementBuilderSupport<T,SELF>

com.foreach.across.modules.web.ui.elements.builder.AbstractNodeViewElementBuilder<T,SELF>

com.foreach.across.modules.bootstrapui.elements.builder.AbstractHtmlSupportingNodeViewElementBuilder<T,SELF>

com.foreach.across.modules.bootstrapui.elements.builder.AbstractLinkSupportingNodeViewElementBuilder<com.foreach.across.modules.web.ui.elements.NodeViewElement,SELF>

com.foreach.across.modules.bootstrapui.components.builder.NavComponentBuilder<DefaultNavComponentBuilder>

com.foreach.across.modules.bootstrapui.components.builder.DefaultNavComponentBuilder

All Implemented Interfaces:

com.foreach.across.modules.web.ui.elements.builder.HtmlViewElementBuilder<com.foreach.across.modules.web.ui.elements.NodeViewElement,DefaultNavComponentBuilder>, com.foreach.across.modules.web.ui.ViewElementBuilder<com.foreach.across.modules.web.ui.elements.NodeViewElement>

public class DefaultNavComponentBuilder
extends NavComponentBuilder<DefaultNavComponentBuilder>

Builds a Bootstrap nav list structure for a Menu instance. Supports several attributes for influencing how a menu gets translated, see NavComponentBuilder.ATTR_ICON, NavComponentBuilder.ATTR_ITEM_VIEW_ELEMENT, NavComponentBuilder.ATTR_LINK_VIEW_ELEMENT.

Since:

1.1.0

Author:

Arne Vandamme

Nested Class Summary

Nested classes/interfaces inherited from class com.foreach.across.modules.bootstrapui.components.builder.NavComponentBuilder

NavComponentBuilder.Separator

Nested classes/interfaces inherited from class com.foreach.across.modules.web.ui.ViewElementBuilderSupport

com.foreach.across.modules.web.ui.ViewElementBuilderSupport.ElementOrBuilder

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

com.foreach.across.modules.web.ui.ViewElementBuilder.Wither<T extends com.foreach.across.modules.web.ui.ViewElementBuilder>

Field Summary

Fields inherited from class com.foreach.across.modules.bootstrapui.components.builder.NavComponentBuilder

ATTR_ICON, ATTR_ICON_ONLY, ATTR_INSERT_SEPARATOR, ATTR_ITEM_VIEW_ELEMENT, ATTR_KEEP_AS_GROUP, ATTR_KEEP_GROUP_ITEM, ATTR_LINK_VIEW_ELEMENT, ATTR_VIEW_ELEMENT_WITHER, CTX_CURRENT_MENU_ITEM

Fields inherited from class com.foreach.across.modules.web.ui.ViewElementBuilderSupport

customTemplate, name

Constructor Summary

Constructors

Constructor	Description
DefaultNavComponentBuilder()

Method Summary

Modifier and Type	Method	Description
protected com.foreach.across.modules.web.ui.elements.NodeViewElement	buildMenu(com.foreach.across.modules.web.menu.Menu menuToRender, com.foreach.across.modules.web.ui.ViewElementBuilderContext builderContext)
DefaultNavComponentBuilder	dropDownWither(com.foreach.across.modules.web.ui.ViewElement.WitherSetter<com.foreach.across.modules.web.ui.elements.HtmlViewElement> dropDownWither)	Configure a wither method to be added to each dropdown item being generated.
DefaultNavComponentBuilder	navbar()	Render menu as navbar links.
DefaultNavComponentBuilder	pills()	Render menu as pills.
DefaultNavComponentBuilder	replaceGroupBySelectedItem()	Shorthand for replaceGroupBySelectedItem(true).
DefaultNavComponentBuilder	replaceGroupBySelectedItem(boolean replaceGroup)	If true, whenever a group has one of its items selected, the link text for the group will be replaced by the text of the selected item.
DefaultNavComponentBuilder	simple()	Render menu with no specific nav style.
DefaultNavComponentBuilder	stacked()	Render menu as stacked pills, with a dropright.
DefaultNavComponentBuilder	tabs()	Render menu as tabs.

Methods inherited from class com.foreach.across.modules.bootstrapui.components.builder.NavComponentBuilder

addHtmlAttributes, addIconAndText, addItemLink, addViewElementIfAttributeExists, createElement, customizeViewElement, customizeViewElement, filter, findFirstIncludedChild, findItemToRender, getFirstNonGroupSelectedItem, htmlAttribute, htmlAttributesOf, includedItems, includePathAsDataAttribute, keepGroupsAsGroup, menu, menu, numberOfChildrenToInclude, shouldIncludeItem, shouldKeepAsGroup, witherAttribute

Methods inherited from class com.foreach.across.modules.bootstrapui.elements.builder.AbstractLinkSupportingNodeViewElementBuilder

buildLink, linkBuilder

Methods inherited from class com.foreach.across.modules.bootstrapui.elements.builder.AbstractHtmlSupportingNodeViewElementBuilder

escapeHtml, isEscapeHtml, resolveTextElement, toTextElement

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

apply, attribute, attributes, clearAttributes, css, htmlId, removeAttribute, removeCss

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

add, add, addAll, addFirst, addFirst, sort

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

build, configure, customTemplate, elementSupplier, elementSupplier, name, postProcess, postProcessor, registerWebResources, with

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.elements.builder.HtmlViewElementBuilder

data, removeData

Methods inherited from interface com.foreach.across.modules.web.ui.ViewElementBuilder

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

Constructor Details

DefaultNavComponentBuilder

public DefaultNavComponentBuilder()

Method Details

simple

public DefaultNavComponentBuilder simple()

Render menu with no specific nav style.

Returns:

current builder

tabs

public DefaultNavComponentBuilder tabs()

Render menu as tabs.

Returns:

current builder

pills

public DefaultNavComponentBuilder pills()

Render menu as pills.

Returns:

current builder

stacked

public DefaultNavComponentBuilder stacked()

Render menu as stacked pills, with a dropright.

Returns:

current builder

navbar

public DefaultNavComponentBuilder navbar()

Render menu as navbar links.

Returns:

current builder

replaceGroupBySelectedItem

public DefaultNavComponentBuilder replaceGroupBySelectedItem()

Shorthand for replaceGroupBySelectedItem(true).

Returns:

current builder

dropDownWither

public DefaultNavComponentBuilder dropDownWither(com.foreach.across.modules.web.ui.ViewElement.WitherSetter<com.foreach.across.modules.web.ui.elements.HtmlViewElement> dropDownWither)

Configure a wither method to be added to each dropdown item being generated. Can be used to set for example the dropdown direction.

Returns:

current builder

replaceGroupBySelectedItem

public DefaultNavComponentBuilder replaceGroupBySelectedItem(boolean replaceGroup)

If true, whenever a group has one of its items selected, the link text for the group will be replaced by the text of the selected item. Only the url and optional NavComponentBuilder.ATTR_ICON attribute of the selected item will be returned. Default behaviour is not to do this but it can be user friendly in a tab navigation.

Parameters:

replaceGroup - true to replace the group label

Returns:

current builder

buildMenu

protected com.foreach.across.modules.web.ui.elements.NodeViewElement buildMenu(com.foreach.across.modules.web.menu.Menu menuToRender,
 com.foreach.across.modules.web.ui.ViewElementBuilderContext builderContext)

Specified by:

buildMenu in class NavComponentBuilder<DefaultNavComponentBuilder>