org.devacfr.maven.skins.reflow.model

Class TocSidebar

java.lang.Object

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

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

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

org.devacfr.maven.skins.reflow.model.TocSidebar

public class TocSidebar
extends Toc<TocSidebar>

Since:

2.0

Author:

devacfr

Field Summary

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

COMPONENT

Constructor Summary

Constructors

Constructor and Description
TocSidebar(ISkinConfig config) Default constructor.

Method Summary

Modifier and Type	Method and Description
int	getLevel()
boolean	isAutoExpandable() Gets the indicating whether is auto-expanded.
boolean	isExpanded() Gets the indicating whether is expanded.
boolean	isFixed() Gets the indicating whether is fixed.
protected TocSidebar	withAutoExpandable(boolean autoExpandable) Sets the indicating whether is auto-expanded.
protected TocSidebar	withExpanded(boolean expanded) Sets the indicating whether is expanded.
protected TocSidebar	withFixed(boolean fixed) Sets the indicating whether is fixed.
protected TocSidebar	withLevel(int level) Sets the level limit 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, getBodyContent, getCssOptions, getHtmlTool, setCssClass

Methods inherited from class java.lang.Object

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

Constructor Detail

TocSidebar

public TocSidebar(@Nonnull
                  ISkinConfig config)

Default constructor.

Parameters:

config - a config (can not be null).

Method Detail

isFixed

public boolean isFixed()

Gets the indicating whether is fixed.

Returns:

Returns true if is fixed, otherwise false.

withFixed

protected TocSidebar withFixed(boolean fixed)

Sets the indicating whether is fixed.

Parameters:

fixed - true is fixed.

Returns:

Returns the fluent instance.

isExpanded

public boolean isExpanded()

Gets the indicating whether is expanded.

Returns:

Returns true if is expanded, otherwise false.

withExpanded

protected TocSidebar withExpanded(boolean expanded)

Sets the indicating whether is expanded.

Parameters:

expanded - true is expanded.

Returns:

Returns the fluent instance.

isAutoExpandable

public boolean isAutoExpandable()

Gets the indicating whether is auto-expanded.

Returns:

Returns true if is expanded, otherwise false.

withAutoExpandable

protected TocSidebar withAutoExpandable(boolean autoExpandable)

Sets the indicating whether is auto-expanded.

Parameters:

autoExpandable - true is auto-expanded.

Returns:

Returns the fluent instance.

getLevel

public int getLevel()

Returns:

Returns the level limit to display.

withLevel

protected TocSidebar withLevel(int level)

Sets the level limit to display

Parameters:

level - the level to use.

Returns:

Returns the fluent instance.