uk.ac.ed.ph.snuggletex

Class WebPageOutputOptions

java.lang.Object

uk.ac.ed.ph.snuggletex.DOMOutputOptions

uk.ac.ed.ph.snuggletex.XMLStringOutputOptions

uk.ac.ed.ph.snuggletex.WebPageOutputOptions

All Implemented Interfaces:

Cloneable, SerializationSpecifier

public class WebPageOutputOptions
extends XMLStringOutputOptions

Builds on XMLStringOutputOptions to add in options for configuring how to build a web page using the relevant methods in SnuggleSession (e.g. SnuggleSession.buildWebPage(WebPageOutputOptions)).

As of SnuggleTeX 1.3, you will generally want to use the various static methods in WebPageOutputOptionsBuilder to create instances of this class that you can tweak slightly.

The older WebPageOutputOptionsTemplates is now deprecated and will be removed in SnuggleTeX 1.4.

Version:

$Revision$

Author:

David McKain

See Also:

DOMOutputOptions, XMLStringOutputOptions, WebPageOutputOptionsBuilder, WebPageOutputOptionsTemplates

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebPageOutputOptions.WebPageType Deprecated. Use WebPageOutputOptionsBuilder to generate different types of web pages. More properties have been added to this class to control some of the finer aspects of this.

Nested classes/interfaces inherited from class uk.ac.ed.ph.snuggletex.DOMOutputOptions

DOMOutputOptions.ErrorOutputOptions

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CONTENT_TYPE Default content type
static String	DEFAULT_LANG Default language

Fields inherited from class uk.ac.ed.ph.snuggletex.DOMOutputOptions

DEFAULT_MATHML_PREFIX, DEFAULT_SNUGGLETEX_XML_PREFIX, DEFAULT_XHTML_PREFIX

Fields inherited from interface uk.ac.ed.ph.snuggletex.SerializationSpecifier

DEFAULT_ENCODING, DEFAULT_INDENT

Constructor Summary

Constructors

Constructor and Description
WebPageOutputOptions()

Method Summary

Modifier and Type	Method and Description
void	addClientSideXSLTStylesheetURLs(String... clientSideXSLTStylesheetURLs) Appends to existing array of relative URLs specifying client-side XSLT stylesheets to be referenced in the resulting page.
void	addCSSStylesheetURLs(String... cssStylesheetURLs) Appends to existing array of relative URLs specifying client-side CSS stylesheets to be referenced in the resulting page.
void	addStylesheets(Transformer... stylesheets) Appends to existing array of JAXP Transformers representing XSLT stylesheet(s) that will be applied to the resulting web page once it has been built but before it is serialised.
String[]	getClientSideXSLTStylesheetURLs() Returns specified array of relative URLs specifying client-side XSLT stylesheets to be referenced in the resulting page.
String	getContentType() Returns the MIME type for the resulting page.
String[]	getCSSStylesheetURLs() Returns specified array of relative URLs specifying client-side CSS stylesheets to be referenced in the resulting page.
String	getCustomMathJaxUrl()
String	getLang() Returns the language of the resulting page, null if not set.
String	getMathPrefRenderer() Gets the value of the optional pref:renderer attribute (in the W3CConstants.MATHML_PREF_NAMESPACE) that can be added to the HTML root element to control certain aspects of the client-side Universal StyleSheets for MathML The default is null, indicating that no attribute will be added
Transformer[]	getStylesheets() Returns an array of specified JAXP Transformers representing XSLT stylesheet(s) that will be applied to the resulting web page once it has been built but before it is serialised.
String	getTitle() Returns the title for the resulting page, null if not set.
WebPageOutputOptions.WebPageType	getWebPageType() Deprecated. Use various methods in WebPageOutputOptionsBuilder to generate suitable options for various types of pages, which you can then tweak.
boolean	isAddingMathPlayerImport() Returns whether to include the necessary processing instruction and object element required to explicitly trigger the MathPlayer plugin.
boolean	isAddingTitleHeading() Returns whether page title should be inserted at the start of the web page body as an XHTML h1 element.
boolean	isHtml5()
boolean	isIncludingStyleElement() Returns whether to include SnuggleTeX-related CSS as a style element within the resulting page.
boolean	isMathJax()
boolean	isNoCharsetInContentTypeHeader()
void	setAddingMathPlayerImport(boolean addingMathPlayerImport) Sets whether to include the necessary processing instruction and object element required to explicitly trigger the MathPlayer plugin.
void	setAddingTitleHeading(boolean addingTitleHeading) Sets whether page title should be inserted at the start of the web page body as an XHTML h1 element.
void	setClientSideXSLTStylesheetURLs(String... clientSideXSLTStylesheetURLs) Sets an array of relative URLs specifying client-side XSLT stylesheets to be referenced in the resulting page.
void	setContentType(String contentType) Sets the MIME type for the resulting page.
void	setCSSStylesheetURLs(String... cssStylesheetURLs) Specifies an array of relative URLs specifying client-side CSS stylesheets to be referenced in the resulting page.
void	setCustomMathJaxUrl(String mathJaxPath)
void	setHtml5(boolean html5)
void	setIncludingStyleElement(boolean includingStyleElement) Sets whether to include SnuggleTeX-related CSS as a style element within the resulting page.
void	setLang(String lang) Sets the language of the resulting page.
void	setMathJax(boolean mathJax)
void	setMathPrefRenderer(String mathPrefRenderer) Sets the value of the optional pref:renderer attribute (in the W3CConstants.MATHML_PREF_NAMESPACE) that can be added to the HTML root element to control certain aspects of the client-side Universal StyleSheets for MathML A null value is allowed, which prevents such an attribute being added.
void	setNoCharsetInContentTypeHeader(boolean noCharsetInContentTypeHeader)
void	setStylesheets(Transformer... stylesheets) Sets an array of JAXP Transformers representing XSLT stylesheet(s) that will be applied to the resulting web page once it has been built but before it is serialised.
void	setTitle(String title) Sets the title for the resulting page.
void	setWebPageType(WebPageOutputOptions.WebPageType webPageType) Deprecated. Use various methods in WebPageOutputOptionsBuilder to generate suitable options for various types of pages, which you can then tweak.

Methods inherited from class uk.ac.ed.ph.snuggletex.XMLStringOutputOptions

getDoctypePublic, getDoctypeSystem, getEncoding, getIndent, getSerializationMethod, isIncludingXMLDeclaration, isIndenting, isUsingNamedEntities, setDoctypePublic, setDoctypeSystem, setEncoding, setIncludingXMLDeclaration, setIndent, setIndenting, setSerializationMethod, setUsingNamedEntities

Methods inherited from class uk.ac.ed.ph.snuggletex.DOMOutputOptions

addDOMPostProcessors, clone, getDOMPostProcessors, getErrorOutputOptions, getInlineCSSProperties, getLinkResolver, getMathMLPrefix, getSnuggleXMLPrefix, getXHTMLPrefix, isAddingMathAnnotations, isAddingMathSourceAnnotations, isApplyingFirefox3SemanticsWorkaround, isInliningCSS, isMathVariantMapping, isPrefixingMathML, isPrefixingSnuggleXML, isPrefixingXHTML, setAddingMathAnnotations, setAddingMathSourceAnnotations, setApplyingFirefox3SemanticsWorkaround, setDOMPostProcessors, setErrorOutputOptions, setInlineCSSProperties, setInliningCSS, setLinkResolver, setMathMLPrefix, setMathVariantMapping, setPrefixingMathML, setPrefixingSnuggleXML, setPrefixingXHTML, setSnuggleXMLPrefix, setXHTMLPrefix

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONTENT_TYPE

public static final String DEFAULT_CONTENT_TYPE

Default content type

See Also:

Constant Field Values

DEFAULT_LANG

public static final String DEFAULT_LANG

Default language

See Also:

Constant Field Values

Constructor Detail

WebPageOutputOptions

public WebPageOutputOptions()

Method Detail

getWebPageType

@Deprecated
public WebPageOutputOptions.WebPageType getWebPageType()

Deprecated. Use various methods in WebPageOutputOptionsBuilder to generate suitable options for various types of pages, which you can then tweak.

Before SnuggleTeX 1.3.0, this returned the desired "type" of web page to be constructed.

From SnuggleTeX 1.3.0, this property no longer controls anything.

setWebPageType

@Deprecated
public void setWebPageType(WebPageOutputOptions.WebPageType webPageType)

Deprecated. Use various methods in WebPageOutputOptionsBuilder to generate suitable options for various types of pages, which you can then tweak.

Before SnuggleTeX 1.3.0, this returned the desired "type" of web page to be constructed.

From SnuggleTeX 1.3.0, this property no longer controls anything.

getContentType

public String getContentType()

Returns the MIME type for the resulting page.

Defaults to DEFAULT_CONTENT_TYPE.

setContentType

public void setContentType(String contentType)

Sets the MIME type for the resulting page.

Parameters:

contentType - desired contentType, which must not be null.

getLang

public String getLang()

Returns the language of the resulting page, null if not set.

Defaults to DEFAULT_LANG.

setLang

public void setLang(String lang)

Sets the language of the resulting page.

Parameters:

lang - desired language, which may be null.

getTitle

public String getTitle()

Returns the title for the resulting page, null if not set.

Default is null.

This is used to generate a title and possible a h1 header if isAddingTitleHeading() returns true.

setTitle

public void setTitle(String title)

Sets the title for the resulting page.

This is used to generate a title and possible a h1 header if isAddingTitleHeading() returns true.

Parameters:

title - title for the required page, which may be null to indicate that no title should be included.

isAddingTitleHeading

public boolean isAddingTitleHeading()

Returns whether page title should be inserted at the start of the web page body as an XHTML h1 element.

Default is false.

This has no effect if getTitle() returns null.

setAddingTitleHeading

public void setAddingTitleHeading(boolean addingTitleHeading)

Sets whether page title should be inserted at the start of the web page body as an XHTML h1 element.

This has no effect if getTitle() returns null.

Parameters:

addingTitleHeading - true to add a title header if a title has been set, false otherwise.

isAddingMathPlayerImport

public boolean isAddingMathPlayerImport()

Returns whether to include the necessary processing instruction and object element required to explicitly trigger the MathPlayer plugin.

Returns:

true if adding MathPlayer import gubbins, false otherwise.

Since:

1.3.0

setAddingMathPlayerImport

public void setAddingMathPlayerImport(boolean addingMathPlayerImport)

Sets whether to include the necessary processing instruction and object element required to explicitly trigger the MathPlayer plugin.

Parameters:

addingMathPlayerImport - true to add gubbins for importing MathPlayer, false otherwise.

Since:

1.3.0

getMathPrefRenderer

public String getMathPrefRenderer()

Gets the value of the optional pref:renderer attribute (in the W3CConstants.MATHML_PREF_NAMESPACE) that can be added to the HTML root element to control certain aspects of the client-side Universal StyleSheets for MathML

The default is null, indicating that no attribute will be added

Since:

1.3.0

setMathPrefRenderer

public void setMathPrefRenderer(String mathPrefRenderer)

Sets the value of the optional pref:renderer attribute (in the W3CConstants.MATHML_PREF_NAMESPACE) that can be added to the HTML root element to control certain aspects of the client-side Universal StyleSheets for MathML

A null value is allowed, which prevents such an attribute being added.

Since:

1.3.0

isIncludingStyleElement

public boolean isIncludingStyleElement()

Returns whether to include SnuggleTeX-related CSS as a style element within the resulting page. If you choose not to do this, you probably want to put snuggletex.css somewhere accessible and pass its location in via setClientSideXSLTStylesheetURLs(String...).

As of SnuggleTeX 1.2.3, this option is ignored if DOMOutputOptions.isInliningCSS() returns true as its effect is clearly redundant in this case.

Default is true, as that's the simplest way of getting up to speed quickly.

setIncludingStyleElement

public void setIncludingStyleElement(boolean includingStyleElement)

Sets whether to include SnuggleTeX-related CSS as a style element within the resulting page. If you choose not to do this, you probably want to put snuggletex.css somewhere accessible and pass its location in via setClientSideXSLTStylesheetURLs(String...).

As of SnuggleTeX 1.2.3, this option is ignored if DOMOutputOptions.isInliningCSS() returns true as its effect is clearly redundant in this case.

Parameters:

includingStyleElement - set to true to include a style element, false otherwise.

getCSSStylesheetURLs

public String[] getCSSStylesheetURLs()

Returns specified array of relative URLs specifying client-side CSS stylesheets to be referenced in the resulting page.

Default is null.

The URLs are used as-is; the caller should have ensured they make sense in advance!

The caller can use this to specify the location of snuggletex.css, as well as any other required stylesheets.

setCSSStylesheetURLs

public void setCSSStylesheetURLs(String... cssStylesheetURLs)

Specifies an array of relative URLs specifying client-side CSS stylesheets to be referenced in the resulting page.

The URLs are used as-is; the caller should have ensured they make sense in advance!

The caller can use this to specify the location of snuggletex.css, as well as any other required stylesheets.

Parameters:

cssStylesheetURLs - array of CSS stylesheet URLs, which may be empty

addCSSStylesheetURLs

public void addCSSStylesheetURLs(String... cssStylesheetURLs)

Appends to existing array of relative URLs specifying client-side CSS stylesheets to be referenced in the resulting page.

The URLs are used as-is; the caller should have ensured they make sense in advance!

The caller can use this to specify the location of snuggletex.css, as well as any other required stylesheets.

Parameters:

cssStylesheetURLs - array of CSS stylesheet URLs to add, which may be empty

getClientSideXSLTStylesheetURLs

public String[] getClientSideXSLTStylesheetURLs()

Returns specified array of relative URLs specifying client-side XSLT stylesheets to be referenced in the resulting page.

Default is null

The URLs are used as-is; the caller should have ensured they make sense in advance!

This is ignored for WebPageOutputOptions.WebPageType.MATHPLAYER_HTML. Also, if nothing is set here for a WebPageOutputOptions.WebPageType.CLIENT_SIDE_XSLT_STYLESHEET then WebPageOutputOptions.WebPageType.MOZILLA will be used as a template instead.

setClientSideXSLTStylesheetURLs

public void setClientSideXSLTStylesheetURLs(String... clientSideXSLTStylesheetURLs)

Sets an array of relative URLs specifying client-side XSLT stylesheets to be referenced in the resulting page.

The URLs are used as-is; the caller should have ensured they make sense in advance!

This is ignored for WebPageOutputOptions.WebPageType.MATHPLAYER_HTML. Also, if nothing is set here for a WebPageOutputOptions.WebPageType.CLIENT_SIDE_XSLT_STYLESHEET then WebPageOutputOptions.WebPageType.MOZILLA will be used as a template instead.

Parameters:

clientSideXSLTStylesheetURLs - array of URLs to use, which may be empty.

addClientSideXSLTStylesheetURLs

public void addClientSideXSLTStylesheetURLs(String... clientSideXSLTStylesheetURLs)

Appends to existing array of relative URLs specifying client-side XSLT stylesheets to be referenced in the resulting page.

The URLs are used as-is; the caller should have ensured they make sense in advance!

This is ignored for WebPageOutputOptions.WebPageType.MATHPLAYER_HTML. Also, if nothing is set here for a WebPageOutputOptions.WebPageType.CLIENT_SIDE_XSLT_STYLESHEET then WebPageOutputOptions.WebPageType.MOZILLA will be used as a template instead.

Parameters:

clientSideXSLTStylesheetURLs - array of URLs to append, which may be empty.

getStylesheets

public Transformer[] getStylesheets()

Returns an array of specified JAXP Transformers representing XSLT stylesheet(s) that will be applied to the resulting web page once it has been built but before it is serialised. This can be useful if you want to add in headers and footers to the resulting XHTML web page.

Default is null.

Remember that the XHTML is all in its correct namespace so you will need to write your stylesheet appropriately. Ensure that any further XHTML you generate is also in the correct namespace; it will later be converted to no-namespace HTML if required by the serialisation process.

NOTE: Source documents may contain Processing Instructions (e.g. to invoke MathPlayer) so these must be handled as appropriate.

setStylesheets

public void setStylesheets(Transformer... stylesheets)

Sets an array of JAXP Transformers representing XSLT stylesheet(s) that will be applied to the resulting web page once it has been built but before it is serialised. This can be useful if you want to add in headers and footers to the resulting XHTML web page.

Remember that the XHTML is all in its correct namespace so you will need to write your stylesheet appropriately. Ensure that any further XHTML you generate is also in the correct namespace; it will later be converted to no-namespace HTML if required by the serialisation process.

NOTE: Source documents may contain Processing Instructions (e.g. to invoke MathPlayer) so these must be handled as appropriate.

Parameters:

stylesheets - array of XSLT stylesheets to apply, which may be null. They are applied in the order specified.

addStylesheets

public void addStylesheets(Transformer... stylesheets)

Appends to existing array of JAXP Transformers representing XSLT stylesheet(s) that will be applied to the resulting web page once it has been built but before it is serialised. This can be useful if you want to add in headers and footers to the resulting XHTML web page.

Remember that the XHTML is all in its correct namespace so you will need to write your stylesheet appropriately. Ensure that any further XHTML you generate is also in the correct namespace; it will later be converted to no-namespace HTML if required by the serialisation process.

NOTE: Source documents may contain Processing Instructions (e.g. to invoke MathPlayer) so these must be handled as appropriate.

Parameters:

stylesheets - array of additional XSLT stylesheets to apply, which may be null. They are applied in the order specified.

isHtml5

public boolean isHtml5()

setHtml5

public void setHtml5(boolean html5)

isNoCharsetInContentTypeHeader

public boolean isNoCharsetInContentTypeHeader()

setNoCharsetInContentTypeHeader

public void setNoCharsetInContentTypeHeader(boolean noCharsetInContentTypeHeader)

isMathJax

public boolean isMathJax()

setMathJax

public void setMathJax(boolean mathJax)

getCustomMathJaxUrl

public String getCustomMathJaxUrl()

setCustomMathJaxUrl

public void setCustomMathJaxUrl(String mathJaxPath)