Package org.devacfr.maven.skins.reflow.model

Class TocTopBar

java.lang.Object

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

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

org.devacfr.maven.skins.reflow.model.Toc<TocTopBar>

org.devacfr.maven.skins.reflow.model.TocTopBar

public class TocTopBar
extends Toc<TocTopBar>

Since:

2.0

Author:

devacfr

Field Summary

Fields inherited from class org.devacfr.maven.skins.reflow.model.Toc

COMPONENT

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

config

Constructor Summary

Constructors

Constructor	Description
TocTopBar(ISkinConfig config)	Default constructor.

Method Summary

Modifier and Type	Method	Description
int	getNumberItems()
boolean	isFlatten()	Gets the indicating whether is flatten.
protected TocTopBar	withFlatten(boolean flatten)	Sets the indicating whether is flatten.
protected TocTopBar	withNumberItems(int numberItems)	Sets the number of items to display.

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

createSidebar, createToc, createTopBar, getTocItems, getType, isEnabled, onPreRender, self, toString, withEnabled

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, getCssOptions, setCssClass

Methods inherited from class java.lang.Object

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

Constructor Detail

TocTopBar

public TocTopBar(@Nonnull
                 ISkinConfig config)

Default constructor.

Parameters:

config - a config (can not be null).

Method Detail

isFlatten

public boolean isFlatten()

Gets the indicating whether is flatten.

Returns:

Returns true if is flatten, otherwise false.

withFlatten

protected TocTopBar withFlatten(boolean flatten)

Sets the indicating whether is flatten.

Parameters:

flatten - true to flat.

Returns:

Returns the fluent instance.

getNumberItems

public int getNumberItems()

Returns:

Returns the number of items to display.

withNumberItems

protected TocTopBar withNumberItems(int numberItems)

Sets the number of items to display.

Parameters:

numberItems - -1 or the number of items to display

Returns:

Returns the fluent instance.