org.devacfr.maven.skins.reflow.context

Class Context<T extends Context<?>>

java.lang.Object

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

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

Type Parameters:

T - type of inherrit context object.

Direct Known Subclasses:

BodyContext, DocumentContext, FrameContext, PageContext

public abstract class Context<T extends Context<?>>
extends Component

The base class of all contexts depending type of page.

Since:

2.0

Author:

Christophe Friederich

Constructor Summary

Constructors

Constructor and Description
Context(ISkinConfig config, ContextType type) Default constructor.

Method Summary

Modifier and Type	Method and Description
static Context<?>	buildContext(ISkinConfig config) Build a context depending of current type of page.
Footer	getFooter()
Navbar	getNavbar()
ScrollTop	getScrollTop()
String	getType()
protected void	initialize(ISkinConfig config) Allows to initialize the context.
protected String	onPreRender(ISkinConfig skinConfig, String bodyContent) generic pre-rendering method executed on all components of context.
String	preRender(ISkinConfig skinConfig) Allows to execute action before rendering of component.
String	renderSnippets(ISkinConfig skinConfig, String bodyContent)
protected T	self()
String	toString()
protected T	withType(ContextType type) Sets the type of context.

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

Context

public Context(@Nonnull
               ISkinConfig config,
               @Nonnull
               ContextType type)

Default constructor.

Parameters:

config - a config (can not be null).

type - the type of context (can not be null).

Method Detail

buildContext

@Nonnull
public static Context<?> buildContext(@Nonnull
                                               ISkinConfig config)

Build a context depending of current type of page.

Parameters:

config - a config (can not be null).

Returns:

Returns a new instance of Context depending of current page.

initialize

protected void initialize(@Nonnull
                          ISkinConfig config)

Allows to initialize the context.

Parameters:

config - a config (can not be null).

preRender

public String preRender(@Nonnull
                        ISkinConfig skinConfig)

Allows to execute action before rendering of component.

Parameters:

skinConfig - a config (can not be null).

Returns:

Returns the String representing the transformed body content.

Since:

2.1

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.

renderSnippets

public String renderSnippets(ISkinConfig skinConfig,
                             String bodyContent)
                      throws IOException

Throws:

IOException

getNavbar

public Navbar getNavbar()

Returns:

Returns the Navbar.

getScrollTop

public ScrollTop getScrollTop()

Returns:

Returns the ScrollTop.

getFooter

public Footer getFooter()

Returns:

Returns the Footer.

withType

protected T withType(ContextType type)

Sets the type of context.

Parameters:

type - the of context.

Returns:

Returns the fluent instance context.

getType

public String getType()

Returns:

Returns the type of context of page.

self

protected T self()

Returns:

Returns the fluent instance.

toString

public String toString()

Overrides:

toString in class Object