com.helger.bootstrap3.ext

Class BootstrapMenuItemRenderer

java.lang.Object

com.helger.webbasics.app.menu.ui.AbstractMenuItemRenderer<com.helger.html.hc.html.HCUL>

com.helger.bootstrap3.ext.BootstrapMenuItemRenderer

All Implemented Interfaces:

com.helger.webbasics.app.menu.ui.IMenuItemRenderer<com.helger.html.hc.html.HCUL>

Direct Known Subclasses:

BootstrapMenuItemRendererHorz

public class BootstrapMenuItemRenderer
extends com.helger.webbasics.app.menu.ui.AbstractMenuItemRenderer<com.helger.html.hc.html.HCUL>

Default implementation of IMenuItemRenderer

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
BootstrapMenuItemRenderer(Locale aContentLocale)

Method Summary

Methods

Modifier and Type	Method and Description
static com.helger.html.hc.IHCElement<?>	createSideBarMenu(com.helger.webbasics.app.layout.ILayoutExecutionContext aLEC)
static com.helger.html.hc.IHCElement<?>	createSideBarMenu(com.helger.webbasics.app.layout.ILayoutExecutionContext aLEC, com.helger.appbasics.app.menu.IMenuTree aMenuTree, com.helger.appbasics.app.menu.IMenuItemDeterminatorCallback aDeterminator, BootstrapMenuItemRenderer aRenderer)
static com.helger.html.hc.IHCElement<?>	createSideBarMenu(com.helger.webbasics.app.layout.ILayoutExecutionContext aLEC, com.helger.appbasics.app.menu.IMenuTree aMenuTree, com.helger.appbasics.app.menu.MenuItemDeterminatorCallback aDeterminator)
static com.helger.html.hc.IHCElement<?>	createSideBarMenu(com.helger.webbasics.app.layout.ILayoutExecutionContext aLEC, com.helger.appbasics.app.menu.MenuItemDeterminatorCallback aDeterminator)
protected String	getMenuItemExternalLabel(com.helger.appbasics.app.menu.IMenuItemExternal aMenuItem, boolean bHasChildren, boolean bIsSelected, boolean bIsExpanded) Get the label to display.
protected String	getMenuItemPageLabel(com.helger.appbasics.app.menu.IMenuItemPage aMenuItem, boolean bHasChildren, boolean bIsSelected, boolean bIsExpanded) Get the label to display.
void	onLevelDown(com.helger.html.hc.html.HCUL aNewLevel)
void	onMenuItemExternalItem(com.helger.webbasics.app.ISimpleWebExecutionContext aSWEC, com.helger.html.hc.html.HCLI aLI, boolean bHasChildren, boolean bSelected, boolean bExpanded)
void	onMenuItemPageItem(com.helger.webbasics.app.ISimpleWebExecutionContext aSWEC, com.helger.html.hc.html.HCLI aLI, boolean bHasChildren, boolean bSelected, boolean bExpanded)
com.helger.html.hc.IHCNode	renderMenuItemExternal(com.helger.webbasics.app.ISimpleWebExecutionContext aSWEC, com.helger.appbasics.app.menu.IMenuItemExternal aMenuItem, boolean bHasChildren, boolean bIsSelected, boolean bIsExpanded)
com.helger.html.hc.IHCNode	renderMenuItemPage(com.helger.webbasics.app.ISimpleWebExecutionContext aSWEC, com.helger.appbasics.app.menu.IMenuItemPage aMenuItem, boolean bHasChildren, boolean bIsSelected, boolean bIsExpanded)
com.helger.html.hc.IHCNode	renderSeparator(com.helger.webbasics.app.ISimpleWebExecutionContext aSWEC, com.helger.appbasics.app.menu.IMenuSeparator aSeparator)

Methods inherited from class com.helger.webbasics.app.menu.ui.AbstractMenuItemRenderer

getContentLocale, onLevelUp, onMenuSeparatorItem

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BootstrapMenuItemRenderer

public BootstrapMenuItemRenderer(@Nonnull
                         Locale aContentLocale)

Method Detail

renderSeparator

@Nonnull
public com.helger.html.hc.IHCNode renderSeparator(@Nonnull
                                                 com.helger.webbasics.app.ISimpleWebExecutionContext aSWEC,
                                                 @Nonnull
                                                 com.helger.appbasics.app.menu.IMenuSeparator aSeparator)

getMenuItemPageLabel

@Nonnull
@OverrideOnDemand
protected String getMenuItemPageLabel(@Nonnull
                                                   com.helger.appbasics.app.menu.IMenuItemPage aMenuItem,
                                                   boolean bHasChildren,
                                                   boolean bIsSelected,
                                                   boolean bIsExpanded)

Get the label to display.

Parameters:

aMenuItem - Menu item. Never null.

bHasChildren - true if the item has children

bIsSelected - true if it is selected

bIsExpanded - true if it is expanded.

Returns:

The label text. Should not be null.

See Also:

AbstractMenuItemRenderer.getContentLocale()

renderMenuItemPage

@Nonnull
public com.helger.html.hc.IHCNode renderMenuItemPage(@Nonnull
                                                    com.helger.webbasics.app.ISimpleWebExecutionContext aSWEC,
                                                    @Nonnull
                                                    com.helger.appbasics.app.menu.IMenuItemPage aMenuItem,
                                                    boolean bHasChildren,
                                                    boolean bIsSelected,
                                                    boolean bIsExpanded)

getMenuItemExternalLabel

@Nonnull
@OverrideOnDemand
protected String getMenuItemExternalLabel(@Nonnull
                                                       com.helger.appbasics.app.menu.IMenuItemExternal aMenuItem,
                                                       boolean bHasChildren,
                                                       boolean bIsSelected,
                                                       boolean bIsExpanded)

Get the label to display.

Parameters:

aMenuItem - Menu item. Never null.

bHasChildren - true if the item has children

bIsSelected - true if it is selected

bIsExpanded - true if it is expanded.

Returns:

The label text. Should not be null.

See Also:

AbstractMenuItemRenderer.getContentLocale()

renderMenuItemExternal

@Nonnull
public com.helger.html.hc.IHCNode renderMenuItemExternal(@Nonnull
                                                        com.helger.webbasics.app.ISimpleWebExecutionContext aSWEC,
                                                        @Nonnull
                                                        com.helger.appbasics.app.menu.IMenuItemExternal aMenuItem,
                                                        boolean bHasChildren,
                                                        boolean bIsSelected,
                                                        boolean bIsExpanded)

onLevelDown

public void onLevelDown(@Nonnull
               com.helger.html.hc.html.HCUL aNewLevel)

Specified by:

onLevelDown in interface com.helger.webbasics.app.menu.ui.IMenuItemRenderer<com.helger.html.hc.html.HCUL>

Overrides:

onLevelDown in class com.helger.webbasics.app.menu.ui.AbstractMenuItemRenderer<com.helger.html.hc.html.HCUL>

onMenuItemPageItem

public void onMenuItemPageItem(@Nonnull
                      com.helger.webbasics.app.ISimpleWebExecutionContext aSWEC,
                      @Nonnull
                      com.helger.html.hc.html.HCLI aLI,
                      boolean bHasChildren,
                      boolean bSelected,
                      boolean bExpanded)

Specified by:

onMenuItemPageItem in interface com.helger.webbasics.app.menu.ui.IMenuItemRenderer<com.helger.html.hc.html.HCUL>

Overrides:

onMenuItemPageItem in class com.helger.webbasics.app.menu.ui.AbstractMenuItemRenderer<com.helger.html.hc.html.HCUL>

onMenuItemExternalItem

public void onMenuItemExternalItem(@Nonnull
                          com.helger.webbasics.app.ISimpleWebExecutionContext aSWEC,
                          @Nonnull
                          com.helger.html.hc.html.HCLI aLI,
                          boolean bHasChildren,
                          boolean bSelected,
                          boolean bExpanded)

Specified by:

onMenuItemExternalItem in interface com.helger.webbasics.app.menu.ui.IMenuItemRenderer<com.helger.html.hc.html.HCUL>

Overrides:

onMenuItemExternalItem in class com.helger.webbasics.app.menu.ui.AbstractMenuItemRenderer<com.helger.html.hc.html.HCUL>

createSideBarMenu

@Nonnull
public static com.helger.html.hc.IHCElement<?> createSideBarMenu(@Nonnull
                                                         com.helger.webbasics.app.layout.ILayoutExecutionContext aLEC)

createSideBarMenu

@Nonnull
public static com.helger.html.hc.IHCElement<?> createSideBarMenu(@Nonnull
                                                         com.helger.webbasics.app.layout.ILayoutExecutionContext aLEC,
                                                         @Nonnull
                                                         com.helger.appbasics.app.menu.MenuItemDeterminatorCallback aDeterminator)

createSideBarMenu

@Nonnull
public static com.helger.html.hc.IHCElement<?> createSideBarMenu(@Nonnull
                                                         com.helger.webbasics.app.layout.ILayoutExecutionContext aLEC,
                                                         @Nonnull
                                                         com.helger.appbasics.app.menu.IMenuTree aMenuTree,
                                                         @Nonnull
                                                         com.helger.appbasics.app.menu.MenuItemDeterminatorCallback aDeterminator)

createSideBarMenu

@Nonnull
public static com.helger.html.hc.IHCElement<?> createSideBarMenu(@Nonnull
                                                         com.helger.webbasics.app.layout.ILayoutExecutionContext aLEC,
                                                         @Nonnull
                                                         com.helger.appbasics.app.menu.IMenuTree aMenuTree,
                                                         @Nonnull
                                                         com.helger.appbasics.app.menu.IMenuItemDeterminatorCallback aDeterminator,
                                                         @Nonnull
                                                         BootstrapMenuItemRenderer aRenderer)