org.docgene.scripts

Class DocJScriptContext

java.lang.Object

org.scripthelper.context.DefaultScriptContext

org.docgene.scripts.DocJScriptContext

All Implemented Interfaces:

org.scripthelper.context.ScriptContext

public class DocJScriptContext
extends org.scripthelper.context.DefaultScriptContext

Represents the context which is accessible natively for all scripts through the context object. Many methods of this context are only a xrapper around the underlying HookContext.

Constructor Summary

Constructors

Constructor and Description
DocJScriptContext()

Method Summary

Modifier and Type	Method and Description
XMLParagraph	addParagraph(XMLArticle article) Add a paragraph to an arricle.
XMLArticle	createArticle(java.lang.String desc) Create an article.
XMLArticle	createArticle(java.lang.String id, java.lang.String desc) Create an article.
XMLArticle	createArticle(java.lang.String id, java.lang.String desc, boolean keepCase) Create an article.
void	echo(java.lang.String message) Echo an information message through the parser integrated console.
void	err(java.lang.String message) Echo an error message to the System.err Stream.
void	error(java.lang.String message) Echo an error message through the parser integrated console.
int	getElementIndex() Return the index of the currently handled element in the wiki source tree.
java.util.List<ParagraphElement>	getElementsAfter() Return all the elements after the current element.
java.util.List<ParagraphElement>	getElementsBefore() Return all the elements before the current element.
org.docgene.model.globals.ArticlesModel	getModel() Return the Articles Model.
ParagraphElement	getNextElement() Return the next element after the current element.
ParagraphElement	getPreviousElement() Return the previous element before the current element.
ParagraphElement	getSiblingElement(int elementOffset) Return a sibling element with an offset relative to the current element.
java.lang.String	getSiblingElementTypeDecl(int elementOffset) Return the type declaration of the sibling element with an offset relative to the current element.
java.util.Set<java.lang.String>	getSupportedDeclarations(java.lang.String... decl) Creates a set of elements declarations which will be handled by this ElementHook.
java.lang.String	getText(XMLCode code) Return the text associated with a code element.
java.lang.String	getText(XMLPre pre) Return the text associated with a pre element.
boolean	hasNextElement() Return true if there is a next element after the current element.
boolean	hasPreviousElement() Return true if there is a previous element before the current element.
void	insertElementsAfter(ParagraphElement... elements) Insert a list of elements after the current element.
void	insertElementsBefore(ParagraphElement... elements) Insert a list of elements before the current element.
void	out(java.lang.String message) Echo a message to the System.out Stream.
void	removeCurrentElement() Remove the current element.

Methods inherited from class org.scripthelper.context.DefaultScriptContext

__step__, abort, echo, getPath, getScriptLogger, getScriptSource, getScriptWrapper, setLogger, setScriptSource, setScriptWrapper

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scripthelper.context.ScriptContext

clearTab, echo, echo, getAdditionalHelper, getAdditionalHelpers, getHelper, getScriptFile, hasAdditionalHelpers, setProgress, setTab

Constructor Detail

DocJScriptContext

public DocJScriptContext()

Method Detail

getSupportedDeclarations

public java.util.Set<java.lang.String> getSupportedDeclarations(java.lang.String... decl)

Creates a set of elements declarations which will be handled by this ElementHook.

Parameters:

decl - the raay of elements declarations

Returns:

the set of supported elements.

echo

public void echo(java.lang.String message)

Echo an information message through the parser integrated console. The method will defer to DirectoryParser.addInfo(java.lang.String).

Specified by:

echo in interface org.scripthelper.context.ScriptContext

Overrides:

echo in class org.scripthelper.context.DefaultScriptContext

Parameters:

message - the message

out

public void out(java.lang.String message)

Echo a message to the System.out Stream.

Parameters:

message - the message

err

public void err(java.lang.String message)

Echo an error message to the System.err Stream.

Parameters:

message - the message

error

public void error(java.lang.String message)

Echo an error message through the parser integrated console. The method will defer to DirectoryParser.addInfo(java.lang.String).

Specified by:

error in interface org.scripthelper.context.ScriptContext

Overrides:

error in class org.scripthelper.context.DefaultScriptContext

Parameters:

message - the message

getElementIndex

public int getElementIndex()

Return the index of the currently handled element in the wiki source tree. Note that this index does not take into account modifications added by the script.

Returns:

the index

hasPreviousElement

public boolean hasPreviousElement()

Return true if there is a previous element before the current element. Note that this does not take into account modifications added by the script.

Returns:

true if there is a previous element before the current element

hasNextElement

public boolean hasNextElement()

Return true if there is a next element after the current element. Note that this does not take into account modifications added by the script.

Returns:

true if there is a next element after the current element

getPreviousElement

public ParagraphElement getPreviousElement()

Return the previous element before the current element. Note that this does not take into account modifications added by the script.

Returns:

the previous element before the current element

getNextElement

public ParagraphElement getNextElement()

Return the next element after the current element.

Returns:

the next element after the current element

getElementsAfter

public java.util.List<ParagraphElement> getElementsAfter()

Return all the elements after the current element. Note that this list is a copy of the actual list, so changing it will not change the effective list of elements. Use insertElementsAfter(org.docgene.model.ParagraphElement...) if you want to add new elements. This does not take into account modifications added by the script.

Returns:

all the elements after the current element

getElementsBefore

public java.util.List<ParagraphElement> getElementsBefore()

Return all the elements before the current element. Note that this list is a copy of the actual list, so changing it will not change the effective list of elements. This does not take into account modifications added by the script.

Returns:

all the elements before the current element

getSiblingElement

public ParagraphElement getSiblingElement(int elementOffset)

Return a sibling element with an offset relative to the current element. This does not take into account modifications added by the script.

Parameters:

elementOffset - the offset

Returns:

the sibling element

getSiblingElementTypeDecl

public java.lang.String getSiblingElementTypeDecl(int elementOffset)

Return the type declaration of the sibling element with an offset relative to the current element. It will return "none" if the element is null or has no type declaration. This does not take into account modifications added by the script.

Parameters:

elementOffset - the offset

Returns:

the sibling element type declaration

removeCurrentElement

public void removeCurrentElement()

Remove the current element.

insertElementsBefore

public void insertElementsBefore(ParagraphElement... elements)

Insert a list of elements before the current element. This does not take into account modifications added by the script.

Parameters:

elements - the list of elements

insertElementsAfter

public void insertElementsAfter(ParagraphElement... elements)

Insert a list of elements after the current element. This does not take into account modifications added by the script.

Parameters:

elements - the list of elements

createArticle

public XMLArticle createArticle(java.lang.String desc)

Create an article.

Parameters:

desc - the article description

Returns:

the article

createArticle

public XMLArticle createArticle(java.lang.String id,
                                java.lang.String desc)

Create an article.

Parameters:

id - the article id (maybe null)

desc - the article description

Returns:

the article

addParagraph

public XMLParagraph addParagraph(XMLArticle article)

Add a paragraph to an arricle.

Parameters:

article - the article

Returns:

the paragraph

createArticle

public XMLArticle createArticle(java.lang.String id,
                                java.lang.String desc,
                                boolean keepCase)

Create an article.

Parameters:

id - the article id (maybe null)

desc - the article description

keepCase - true if the article description should keep the title description case

Returns:

the article

getText

public java.lang.String getText(XMLCode code)

Return the text associated with a code element.

Parameters:

code - the code element

Returns:

the text

getText

public java.lang.String getText(XMLPre pre)

Return the text associated with a pre element.

Parameters:

pre - the pre element

Returns:

the text

getModel

public org.docgene.model.globals.ArticlesModel getModel()

Return the Articles Model.

Returns:

the Articles Model