org.devacfr.maven.skins.reflow.model

Class Toc<T extends Toc<?>>

java.lang.Object

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

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

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

Type Parameters:

T - the type of inherit of Toc.

Direct Known Subclasses:

TocSidebar, TocTopBar

public abstract class Toc<T extends Toc<?>>
extends BsComponent

Represents the base of Table of content component.

Since:

2.0

Author:

devacfr

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Toc(String type, String component)

Method Summary

Modifier and Type	Method and Description
static Toc<?>	createSidebar(ISkinConfig config)
static Toc<?>	createToc(ISkinConfig config, String preferredType)
static Toc<?>	createTopBar(ISkinConfig config)
List<? extends HtmlTool.IdElement>	getTocItems(ISkinConfig skinConfig)
String	getType()
boolean	isEnabled() Gets the indicating whether is enable.
protected String	onPreRender(ISkinConfig skinConfig, String bodyContent) generic pre-rendering method executed on all components of context.
protected T	self()
String	toString()
protected T	withEnabled(boolean enabled) Sets the indicating whether is enable.

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

Field Detail

COMPONENT

public static final String COMPONENT

See Also:

Constant Field Values

Constructor Detail

Toc

protected Toc(String type,
              String component)

Parameters:

type - the String representation of Toc.

component - the bootstrap component name.

Method Detail

createToc

public static Toc<?> createToc(@Nonnull
                               ISkinConfig config,
                               @Nullable
                               String preferredType)

Parameters:

config - a config (can not be null).

preferredType - the default type of Toc to use.

Returns:

Returns new instance corresponding Toc to configuration.

createSidebar

public static Toc<?> createSidebar(@Nonnull
                                   ISkinConfig config)

Parameters:

config - a config (can not be null).

Returns:

Returns new instance of Toc sidebar.

createTopBar

public static Toc<?> createTopBar(@Nonnull
                                  ISkinConfig config)

Parameters:

config - a config (can not be null).

Returns:

Returns new instance Toc top bar.

self

protected T self()

Returns:

Returns the fluent instance.

getType

public String getType()

Returns:

Returns the String reprensenting the type of Toc.

isEnabled

public boolean isEnabled()

Gets the indicating whether is enable.

Returns:

Returns true if is enable, otherwise false.

getTocItems

public List<? extends HtmlTool.IdElement> getTocItems(ISkinConfig skinConfig)

Parameters:

skinConfig - a config (can not be null).

Returns:

Returns a list of HtmlTool.IdElement representing the heading tree containing in current page.

Since:

2.1

withEnabled

protected T withEnabled(boolean enabled)

Sets the indicating whether is enable.

Parameters:

enabled - status to use.

Returns:

Returns the fluent instance.

onPreRender

protected String onPreRender(@Nonnull
                             ISkinConfig skinConfig,
                             @Nonnull
                             String bodyContent)

Description copied from class: Component

generic pre-rendering method executed on all components of context.

Overrides:

onPreRender in class Component

Parameters:

skinConfig - the current skin config.

bodyContent - the current body content.

Returns:

Returns a String representing the transformed body content on pre-rendering.

toString

public String toString()

Overrides:

toString in class Object