SnuggleTeX 1.3.0 · uk.ac.ed.ph.snuggletex.internal.WebPageBuilder

Modifier and Type	Field and Description
public static final String	DEFAULT_MATHJAX_URL Default URL and config to use when MathJax configuration option has been enabled.
private final WebPageOutputOptions	options
private final SessionContext	sessionContext

Access	Constructor and Description
public	WebPageBuilder(final SessionContext sessionContext, final WebPageOutputOptions options)

Method Summary

Modifier and Type	Method and Description
public final Document	buildWebPage(final List<FlowToken> fixedTokens)
public final String	buildWebPageString(final List<FlowToken> fixedTokens)
private String	computeContentTypeHeader() Computes the appropriate "Content-Type" string to be specified as an HTTP Header.
private String	computeMetaContentType() Computes the appropriate "Content-Type" string to be specified as an the XHTML `meta` element.
private final Transformer	createSerializer()
private Element	createXHTMLElement(Document document, String elementLocalName) Helper to create XHTML elements, setting the correct namespace prefix if required by the underlying`WebPageOutputOptions`.
private Element	createXHTMLElement(Document document, String elementLocalName, String content) Helper to create XHTML text elements, setting the correct namespace prefix if required by the underlying`WebPageOutputOptions`.
public final void	setWebPageContentType(Object Object that will have its `contentType` property set if provided. contentTypeSettable) Calls the `setContentType` method for the given Object (by reflection) to something appropriate for serving the types of web pages generated by this builder over HTTP.
public final void	writeWebPage(final List<FlowToken> fixed Tokens from earlier stages of parsing fixedTokens, Object optional bean Object that will have its `contentType` property set if provided. (This is generally useful as a proxy for the `HttpResponse` Object in the servlet API, which I want to avoid a compile-time dependency on.) contentTypeSettable, final OutputStream Stream to send the resulting page to, which will be closed afterwards. outputStream, final SnuggleSession.EndOutputAction specifies what to do with the outputStream once we've finished writing to it. endOutputOptions) Creates a web page representing the given (fixed) Tokens, and writes the results to the given `OutputStream`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

DEFAULT_MATHJAX_URL	back to summary
public static final String DEFAULT_MATHJAX_URL Default URL and config to use when MathJax configuration option has been enabled.

options	back to summary
private final WebPageOutputOptions options

sessionContext	back to summary
private final SessionContext sessionContext

WebPageBuilder	back to summary
public WebPageBuilder(final SessionContext sessionContext, final WebPageOutputOptions options)

Method Detail

buildWebPage	back to summary
public final Document buildWebPage(final List<FlowToken> fixedTokens) throws SnuggleParseException

buildWebPageString	back to summary
public final String buildWebPageString(final List<FlowToken> fixedTokens) throws SnuggleParseException

computeContentTypeHeader	back to summary
private String computeContentTypeHeader() Computes the appropriate "Content-Type" string to be specified as an HTTP Header. (Note that MathPlayer only sniffs a limited number of Content Types.)

computeMetaContentType back to summary

computeMetaContentType	back to summary
private String computeMetaContentType() Computes the appropriate "Content-Type" string to be specified as an the XHTML `meta` element. See Also `computeContentTypeHeader()`

private String computeMetaContentType()

Computes the appropriate "Content-Type" string to be specified as an the XHTML meta element.

See Also: computeContentTypeHeader()

createSerializer	back to summary
private final Transformer createSerializer() Exceptions SnuggleRuntimeException: if a serializer cannot be created.

createXHTMLElement	back to summary
private Element createXHTMLElement(Document document, String elementLocalName) Helper to create XHTML elements, setting the correct namespace prefix if required by the underlying`WebPageOutputOptions`.

createXHTMLElement	back to summary
private Element createXHTMLElement(Document document, String elementLocalName, String content) Helper to create XHTML text elements, setting the correct namespace prefix if required by the underlying`WebPageOutputOptions`.

setWebPageContentType back to summary

setWebPageContentType	back to summary
public final void setWebPageContentType(Object contentTypeSettable) Calls the `setContentType` method for the given Object (by reflection) to something appropriate for serving the types of web pages generated by this builder over HTTP. (The main example for this would be passing a `javax.servlet.http.HttpResponse` Object, which I want to avoid a compile-time dependency on.) Parameters contentTypeSettable:Object Object that will have its `contentType` property set if provided.

public final void setWebPageContentType(Object contentTypeSettable)

Calls the setContentType method for the given Object (by reflection) to something appropriate for serving the types of web pages generated by this builder over HTTP.

(The main example for this would be passing a javax.servlet.http.HttpResponse Object, which I want to avoid a compile-time dependency on.)

Parameters

contentTypeSettable:Object: Object that will have its contentType property set if provided.

writeWebPage back to summary

writeWebPage	back to summary
public final void writeWebPage(final List<FlowToken> fixedTokens, Object contentTypeSettable, final OutputStream outputStream, final SnuggleSession.EndOutputAction endOutputOptions) throws SnuggleParseException, IOException Creates a web page representing the given (fixed) Tokens, and writes the results to the given `OutputStream`. Parameters fixedTokens:List<FlowToken> fixed Tokens from earlier stages of parsing contentTypeSettable:Object optional bean Object that will have its `contentType` property set if provided. (This is generally useful as a proxy for the `HttpResponse` Object in the servlet API, which I want to avoid a compile-time dependency on.) outputStream:OutputStream Stream to send the resulting page to, which will be closed afterwards. endOutputOptions:SnuggleSession.EndOutputAction specifies what to do with the outputStream once we've finished writing to it. Exceptions SnuggleRuntimeException: if calling `setContentType()` on the contentTypeSettable Object failed, with the underlying Exception wrapped up.

public final void writeWebPage(final List<FlowToken> fixedTokens, Object contentTypeSettable, final OutputStream outputStream, final SnuggleSession.EndOutputAction endOutputOptions) throws SnuggleParseException, IOException

Creates a web page representing the given (fixed) Tokens, and writes the results to the given OutputStream.

Parameters

fixedTokens:List<FlowToken>: fixed Tokens from earlier stages of parsing
contentTypeSettable:Object: optional bean Object that will have its contentType property set if provided. (This is generally useful as a proxy for the HttpResponse Object in the servlet API, which I want to avoid a compile-time dependency on.)
outputStream:OutputStream: Stream to send the resulting page to, which will be closed afterwards.
endOutputOptions:SnuggleSession.EndOutputAction: specifies what to do with the outputStream once we've finished writing to it.

Exceptions

SnuggleRuntimeException:: if calling setContentType() on the contentTypeSettable Object failed, with the underlying Exception wrapped up.

public final Class WebPageBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail