intradoc.common
Interface DynamicHtmlOutput

All Known Implementing Classes:

DynamicHtmlMerger

public interface DynamicHtmlOutput

Callback interface that evaluates server side script elements in template page.

Method Summary

boolean	checkCondition(HtmlChunk chunk, GrammarElement elt) Return true if 'condition' satisfied otherwise return false.
void	doBreakpoint(HtmlChunk chunk)
void	endActiveResultSet() End the loop by removing the result set.
void	evaluateBreakpoint(HtmlChunk chunk) Given the chunk, tries to display contextual information for a breakpoint.
DynamicHtml	getAndRedirectHtmlResource(java.lang.String resName, HtmlChunk chunk) Gets a resource of idoc script to evaluate.
boolean	loadNextRow(HtmlChunk chunk, java.lang.String resultset) Return false if no more result sets to be loaded.
void	registerMerger()
void	setBackRedirectHtmlResource(java.lang.String resName, DynamicHtml dynHtml, HtmlChunk chunk) Undoes the redirection.
void	substituteVariable(HtmlChunk chunk, GrammarElement elt, java.io.Writer writer) Put in substitution desired into output.
void	unregisterMerger()

Method Detail

getAndRedirectHtmlResource

public DynamicHtml getAndRedirectHtmlResource(java.lang.String resName,
                                              HtmlChunk chunk)
                                       throws ParseSyntaxException

Gets a resource of idoc script to evaluate. If a parent version is returned then that parent version is made active until a call to setBackRedirectHtmlResource. This redirection implements the following feature. A resource includes the "super" version of itself, then that "super" version includes yet the more "super" version.

ParseSyntaxException

setBackRedirectHtmlResource

public void setBackRedirectHtmlResource(java.lang.String resName,
                                        DynamicHtml dynHtml,
                                        HtmlChunk chunk)
                                 throws ParseSyntaxException

Undoes the redirection.

ParseSyntaxException

checkCondition

public boolean checkCondition(HtmlChunk chunk,
                              GrammarElement elt)
                       throws java.io.IOException,
                              ParseSyntaxException

Return true if 'condition' satisfied otherwise return false.

java.io.IOException

ParseSyntaxException

loadNextRow

public boolean loadNextRow(HtmlChunk chunk,
                           java.lang.String resultset)
                    throws java.io.IOException

Return false if no more result sets to be loaded.

java.io.IOException

endActiveResultSet

public void endActiveResultSet()

End the loop by removing the result set.

substituteVariable

public void substituteVariable(HtmlChunk chunk,
                               GrammarElement elt,
                               java.io.Writer writer)
                        throws java.io.IOException,
                               ParseSyntaxException

Put in substitution desired into output. Note: if writer is null then caller wants 'elt' to be evaluated but the output suppressed.

java.io.IOException

ParseSyntaxException

evaluateBreakpoint

public void evaluateBreakpoint(HtmlChunk chunk)

Given the chunk, tries to display contextual information for a breakpoint.

registerMerger

public void registerMerger()

unregisterMerger

public void unregisterMerger()

doBreakpoint

public void doBreakpoint(HtmlChunk chunk)