org.devacfr.maven.skins.reflow.context

Class FrameContext

java.lang.Object

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

org.devacfr.maven.skins.reflow.context.Context<FrameContext>

org.devacfr.maven.skins.reflow.context.FrameContext

public class FrameContext
extends Context<FrameContext>

The context associate to page of frame page.

Since:

2.0

Author:

Christophe Friederich

Constructor Summary

Constructors

Constructor and Description
FrameContext(ISkinConfig config, String documentParent)

Method Summary

Modifier and Type	Method and Description
String	getDocumentParent()
String	getSlugDocumentParent()
Toc<?>	getToc()

Methods inherited from class org.devacfr.maven.skins.reflow.context.Context

buildContext, getFooter, getNavbar, getScrollTop, getType, initialize, onPreRender, preRender, renderSnippets, self, toString, withType

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

addChildren, addCssOptions, getBodyContent, getCssClass, getCssOptions, getHtmlTool, setCssClass

Methods inherited from class java.lang.Object

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

Constructor Detail

FrameContext

public FrameContext(@Nonnull
                    ISkinConfig config,
                    @Nonnull
                    String documentParent)

Parameters:

config - a config (can not be null).

documentParent - name of parent.

Method Detail

getDocumentParent

public String getDocumentParent()

Returns:

Returns a String representing the name of parent page.

getSlugDocumentParent

public String getSlugDocumentParent()

Returns:

Returns a String representing the slugged name(pageId) of parent page.

getToc

public Toc<?> getToc()

Returns:

returns the Toc.