org.devacfr.maven.skins.reflow.model

Class NavSideMenu

java.lang.Object

org.devacfr.maven.skins.reflow.model.Component

org.devacfr.maven.skins.reflow.model.BsComponent

org.devacfr.maven.skins.reflow.model.NavSideMenu

public class NavSideMenu
extends BsComponent

Represents the navside menu component used in document page.

A sample configuration would be like that:

 
 <custom>
   <reflowSkin>
     <pages>
       <document type="doc">
          <menu name="Documentation" selectFirstOnExpand="true">
              <item name="Get Started" href="get-started.html" />
              <item name="Layouts">
                  <item name="Overview" href="layouts.html" />
                  <item name="Body" href="body.html" />
              </item>
              <item name="Migration" href="migration.html" />
          </menu>
       </document>
     </pages>
   </reflowSkin>
 </custom>
 ∂
 

Since:

2.0

Author:

Christophe Friederich

Constructor Summary

Constructors

Constructor and Description
NavSideMenu(ISkinConfig config) Default constructor.

Method Summary

Modifier and Type	Method and Description
static List<SideNavMenuItem>	findAllSideNavMenuItems(ISkinConfig config) Find all sidenav menu items declared in all document pages.
List<SideNavMenuItem>	getItems()
String	getName() Gets the name of menu displayed on top of navside menu.
boolean	isHasItems() Gets the indicating whether menu contains a least one menu item.
boolean	isSelectFirstOnExpand() Gets the indicating whether the first sub menu item should be selected when a dropdown menu item is selected and should expand.
String	toString()
protected NavSideMenu	withItems(List<SideNavMenuItem> items) Sets the List of SideNavMenuItem.
protected NavSideMenu	withName(String name) Sets the name of menu displayed on top of navside menu.
protected NavSideMenu	withSelectFirstOnSelect(boolean selectFirstOnExpand) Sets the indicating whether the first sub menu item should be selected when a dropdown menu item is selected and should expand.

Methods inherited from class org.devacfr.maven.skins.reflow.model.BsComponent

getBackground, getCssClass, getTheme, setBackground, setTheme

Methods inherited from class org.devacfr.maven.skins.reflow.model.Component

addChildren, addCssOptions, getBodyContent, getCssOptions, getHtmlTool, onPreRender, setCssClass

Methods inherited from class java.lang.Object

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

Constructor Detail

NavSideMenu

public NavSideMenu(@Nonnull
                   ISkinConfig config)

Default constructor.

Parameters:

config - a config (can not be null).

Method Detail

findAllSideNavMenuItems

@Nonnull
public static List<SideNavMenuItem> findAllSideNavMenuItems(@Nonnull
                                                                     ISkinConfig config)

Find all sidenav menu items declared in all document pages.

Parameters:

config - a config (can not be null).

Returns:

Returns a list of all all sidenav menu items declared in all document pages (returns list can not be null).

getName

@Nullable
public String getName()

Gets the name of menu displayed on top of navside menu.

Returns:

Returns a String representing the name of menu.

withName

protected NavSideMenu withName(String name)

Sets the name of menu displayed on top of navside menu.

Parameters:

name - the name to use.

Returns:

Returns the fluent instance.

isHasItems

public boolean isHasItems()

Gets the indicating whether menu contains a least one menu item.

Returns:

Returns true whether menu contains a least one menu item, otherwise returns false.

getItems

@Nonnull
public List<SideNavMenuItem> getItems()

Returns:

Returns the List of SideNavMenuItem containing in <menu> element.

withItems

protected NavSideMenu withItems(List<SideNavMenuItem> items)

Sets the List of SideNavMenuItem.

Parameters:

items - list of items to use.

Returns:

Returns the fluent instance.

isSelectFirstOnExpand

public boolean isSelectFirstOnExpand()

Gets the indicating whether the first sub menu item should be selected when a dropdown menu item is selected and should expand.

Returns:

Returns true whether the first sub menu item should be selected when a dropdown menu item is selected and expanded, otherwise returns false.

withSelectFirstOnSelect

protected NavSideMenu withSelectFirstOnSelect(boolean selectFirstOnExpand)

Sets the indicating whether the first sub menu item should be selected when a dropdown menu item is selected and should expand.

Parameters:

selectFirstOnExpand - a value to use.

Returns:

Returns the fluent instance.

toString

public String toString()

Overrides:

toString in class Object