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

Class PanelsNavComponentBuilder

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

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

All Implemented Interfaces:

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

public class PanelsNavComponentBuilder
extends NavComponentBuilder<PanelsNavComponentBuilder>

Renders a Menu into a panels structure with list-group items.

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

Modifier and Type	Field	Description
static final String	ATTR_PANEL_STYLE	Deprecated.
static final String	ATTR_RENDER_AS_PANEL	Deprecated.

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
PanelsNavComponentBuilder()

Method Summary

Modifier and Type	Method	Description
protected com.foreach.across.modules.web.ui.elements.NodeViewElement	buildMenu(com.foreach.across.modules.web.menu.Menu menu, com.foreach.across.modules.web.ui.ViewElementBuilderContext builderContext)
PanelsNavComponentBuilder	subMenuBaseId(String htmlId)	Optionally set a base id to be used for generating the unique sub-menu ids.

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

Field Details

ATTR_PANEL_STYLE

@Deprecated
public static final String ATTR_PANEL_STYLE

Deprecated.

Holds the CSS class that determines the panel styling. If set, the default panel-default class will be omitted. Only relevant on group menu items that would result in a panel being rendered.

See Also:

• Constant Field Values

ATTR_RENDER_AS_PANEL

@Deprecated
public static final String ATTR_RENDER_AS_PANEL

Deprecated.

If set to false on an group menu item that would be rendered as a panel (a group on the top level), no panel will be rendered but a sidebar nav list will directly be rendered. Optionally a title will still be included if the group has one.

Note that non-panel lists do not support groups as items, these will be ignored.

See Also:

• Constant Field Values

Constructor Details

PanelsNavComponentBuilder

public PanelsNavComponentBuilder()

Method Details

subMenuBaseId

public PanelsNavComponentBuilder subMenuBaseId(String htmlId)

Optionally set a base id to be used for generating the unique sub-menu ids. Defaults to a UUID.

Parameters:

htmlId - to use as base

Returns:

current builder

buildMenu

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

Specified by:

buildMenu in class NavComponentBuilder<PanelsNavComponentBuilder>