Package org.devacfr.maven.skins.reflow.snippet

Class SnippetContext

java.lang.Object

org.devacfr.maven.skins.reflow.snippet.SnippetContext

public class SnippetContext
extends Object

Version:

2.4

Author:

Christophe Friederich

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SnippetContext.SnippetResource	Represents a snippet resource.

Constructor Summary

Constructors

Constructor	Description
SnippetContext(SnippetParser parser)	Constructor.

Method Summary

Modifier and Type	Method	Description
Component<?>	create(org.jsoup.nodes.Element element, Component<?> parent)	Create a component from element and component.
Component<?>	create(org.jsoup.nodes.Element element, ComponentToken startToken, ComponentToken endToken)	Create a component from element and tokens.
SnippetParser	createChildParser()	Create a child parser.
protected static org.apache.velocity.tools.ToolManager	createToolManaged()	Creates a ToolManager with all generic tools configured.
protected org.apache.velocity.context.Context	createVelocityContext(org.apache.velocity.context.Context contextParent)	Creates a Velocity Context with all generic tools configured wit the site rendering context.
org.jsoup.nodes.Element	document()	Returns the html document.
String	generateSnippetIdentifier()	Generate a unique snippet identifier.
ISkinConfig	getConfig()	Returns the skin configuration.
SnippetParser	getParser()	Returns the current parser.
String	html()	Returns the html source.
protected void	mergeTemplate(SnippetComponent<?> component, org.apache.velocity.context.Context contextParent, Writer writer)	Merges the template for the given component.
protected void	render(Component<?> component)	Render the component.
protected String	renderComponent(SnippetComponent<?> component, org.apache.velocity.context.Context context)
void	reset()	Reset the context.
void	setConfig(ISkinConfig config)	Sets the skin configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

SnippetContext

public SnippetContext(@Nonnull
                      SnippetParser parser)

Constructor.

Parameters:

parser -

Method Detail

reset

public void reset()

Reset the context.

generateSnippetIdentifier

public String generateSnippetIdentifier()

Generate a unique snippet identifier.

Returns:

a unique snippet identifier

getParser

public SnippetParser getParser()

Returns the current parser.

Returns:

the current parser

getConfig

public ISkinConfig getConfig()

Returns the skin configuration.

Returns:

the skin configuration

createChildParser

public SnippetParser createChildParser()

Create a child parser.

Returns:

a new SnippetParser

setConfig

public void setConfig(ISkinConfig config)

Sets the skin configuration.

Parameters:

config - the skin configuration

html

public String html()

Returns the html source.

Returns:

the html source

document

public org.jsoup.nodes.Element document()

Returns the html document.

Returns:

the html document

create

@Nonnull
public Component<?> create(@Nonnull
                           org.jsoup.nodes.Element element,
                           @Nonnull
                           ComponentToken startToken,
                           @Nullable
                           ComponentToken endToken)

Create a component from element and tokens.

Parameters:

element - the html element to use.

startToken - the start token

endToken - the end token.

Returns:

Returns a new Component representing the snippet.

create

@Nonnull
public Component<?> create(@Nonnull
                           org.jsoup.nodes.Element element,
                           Component<?> parent)

Create a component from element and component.

Parameters:

element - the html element to use.

parent - the parent component.

Returns:

Returns a new SnippetComponent representing the snippet.

render

protected void render(Component<?> component)

Render the component.

Parameters:

component - the component to render.

renderComponent

protected String renderComponent(SnippetComponent<?> component,
                                 org.apache.velocity.context.Context context)

mergeTemplate

protected void mergeTemplate(SnippetComponent<?> component,
                             org.apache.velocity.context.Context contextParent,
                             Writer writer)

Merges the template for the given component.

Parameters:

component - the snippet component

contextParent - the velocity context parent

writer - the writer to use.

createVelocityContext

protected org.apache.velocity.context.Context createVelocityContext(org.apache.velocity.context.Context contextParent)

Creates a Velocity Context with all generic tools configured wit the site rendering context.

Parameters:

contextParent - velocity context parent

Returns:

a Velocity tools managed context

createToolManaged

protected static org.apache.velocity.tools.ToolManager createToolManaged()

Creates a ToolManager with all generic tools configured.

Returns:

a Velocity tools managed