WebPageOutputOptions (snuggletex-core 1.5.5 API)

java.lang.Object
- uk.ac.ed.ph.snuggletex.DOMOutputOptions
- - uk.ac.ed.ph.snuggletex.XMLStringOutputOptions
  - - uk.ac.ed.ph.snuggletex.WebPageOutputOptions

所有已实现的接口:

java.lang.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.

另请参阅:

DOMOutputOptions, XMLStringOutputOptions, WebPageOutputOptionsBuilder, WebPageOutputOptionsTemplates

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`WebPageOutputOptions.WebPageType` 已过时。 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.

从类继承的嵌套类/接口 uk.ac.ed.ph.snuggletex.DOMOutputOptions
DOMOutputOptions.ErrorOutputOptions

字段概要

字段
限定符和类型字段和说明

static java.lang.String DEFAULT_CONTENT_TYPE
Default content type

static java.lang.String DEFAULT_LANG
Default language
- 从类继承的字段 uk.ac.ed.ph.snuggletex.DOMOutputOptions
  DEFAULT_MATHML_PREFIX, DEFAULT_SNUGGLETEX_XML_PREFIX, DEFAULT_XHTML_PREFIX
- 从接口继承的字段 uk.ac.ed.ph.snuggletex.SerializationSpecifier
  DEFAULT_ENCODING, DEFAULT_INDENT

字段
限定符和类型	字段和说明
`static java.lang.String`	`DEFAULT_CONTENT_TYPE` Default content type
`static java.lang.String`	`DEFAULT_LANG` Default language

构造器概要

构造器
构造器和说明

WebPageOutputOptions()

构造器
构造器和说明
`WebPageOutputOptions()`

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`void`	`addClientSideXSLTStylesheetURLs(java.lang.String... clientSideXSLTStylesheetURLs)` Appends to existing array of relative URLs specifying client-side XSLT stylesheets to be referenced in the resulting page.
`void`	`addCSSStylesheetURLs(java.lang.String... cssStylesheetURLs)` Appends to existing array of relative URLs specifying client-side CSS stylesheets to be referenced in the resulting page.
`void`	`addStylesheets(javax.xml.transform.Transformer... stylesheets)` Appends to existing array of JAXP `Transformer`s representing XSLT stylesheet(s) that will be applied to the resulting web page once it has been built but before it is serialised.
`java.lang.String[]`	`getClientSideXSLTStylesheetURLs()` Returns specified array of relative URLs specifying client-side XSLT stylesheets to be referenced in the resulting page.
`java.lang.String`	`getContentType()` Returns the MIME type for the resulting page.
`java.lang.String[]`	`getCSSStylesheetURLs()` Returns specified array of relative URLs specifying client-side CSS stylesheets to be referenced in the resulting page.
`java.lang.String`	`getCustomMathJaxUrl()`
`java.lang.String`	`getLang()` Returns the language of the resulting page, null if not set.
`java.lang.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
`javax.xml.transform.Transformer[]`	`getStylesheets()` Returns an array of specified JAXP `Transformer`s representing XSLT stylesheet(s) that will be applied to the resulting web page once it has been built but before it is serialised.
`java.lang.String`	`getTitle()` Returns the title for the resulting page, null if not set.
`WebPageOutputOptions.WebPageType`	`getWebPageType()` 已过时。 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(java.lang.String... clientSideXSLTStylesheetURLs)` Sets an array of relative URLs specifying client-side XSLT stylesheets to be referenced in the resulting page.
`void`	`setContentType(java.lang.String contentType)` Sets the MIME type for the resulting page.
`void`	`setCSSStylesheetURLs(java.lang.String... cssStylesheetURLs)` Specifies an array of relative URLs specifying client-side CSS stylesheets to be referenced in the resulting page.
`void`	`setCustomMathJaxUrl(java.lang.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(java.lang.String lang)` Sets the language of the resulting page.
`void`	`setMathJax(boolean mathJax)`
`void`	`setMathPrefRenderer(java.lang.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(javax.xml.transform.Transformer... stylesheets)` Sets an array of JAXP `Transformer`s 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(java.lang.String title)` Sets the title for the resulting page.
`void`	`setWebPageType(WebPageOutputOptions.WebPageType webPageType)` 已过时。 Use various methods in `WebPageOutputOptionsBuilder` to generate suitable options for various types of pages, which you can then tweak.

从类继承的方法 uk.ac.ed.ph.snuggletex.XMLStringOutputOptions
getDoctypePublic, getDoctypeSystem, getEncoding, getIndent, getSerializationMethod, isIncludingXMLDeclaration, isIndenting, isUsingNamedEntities, setDoctypePublic, setDoctypeSystem, setEncoding, setIncludingXMLDeclaration, setIndent, setIndenting, setSerializationMethod, setUsingNamedEntities

从类继承的方法 java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - DEFAULT_CONTENT_TYPE
```
public static final java.lang.String DEFAULT_CONTENT_TYPE
```
    Default content type
    
    另请参阅:
    
    常量字段值
  - DEFAULT_LANG
```
public static final java.lang.String DEFAULT_LANG
```
    Default language
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - WebPageOutputOptions
```
public WebPageOutputOptions()
```
- 方法详细资料
  - getWebPageType
```
@Deprecated
public WebPageOutputOptions.WebPageType getWebPageType()
```
    已过时。 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)
```
    已过时。 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 java.lang.String getContentType()
```
    Returns the MIME type for the resulting page.
    Defaults to DEFAULT_CONTENT_TYPE.
  - setContentType
```
public void setContentType(java.lang.String contentType)
```
    Sets the MIME type for the resulting page.
    
    参数:
    
    contentType - desired contentType, which must not be null.
  - getLang
```
public java.lang.String getLang()
```
    Returns the language of the resulting page, null if not set.
    Defaults to DEFAULT_LANG.
  - setLang
```
public void setLang(java.lang.String lang)
```
    Sets the language of the resulting page.
    
    参数:
    
    lang - desired language, which may be null.
  - getTitle
```
public java.lang.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(java.lang.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.
    
    参数:
    
    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.
    
    参数:
    
    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.
    
    返回:
    
    true if adding MathPlayer import gubbins, false otherwise.
    
    从以下版本开始:
    
    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.
    
    参数:
    
    addingMathPlayerImport - true to add gubbins for importing MathPlayer, false otherwise.
    
    从以下版本开始:
    
    1.3.0
  - getMathPrefRenderer
```
public java.lang.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
    
    从以下版本开始:
    
    1.3.0
  - setMathPrefRenderer
```
public void setMathPrefRenderer(java.lang.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.
    
    从以下版本开始:
    
    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.
    
    参数:
    
    includingStyleElement - set to true to include a style element, false otherwise.
  - getCSSStylesheetURLs
```
public java.lang.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(java.lang.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.
    
    参数:
    
    cssStylesheetURLs - array of CSS stylesheet URLs, which may be empty
  - addCSSStylesheetURLs
```
public void addCSSStylesheetURLs(java.lang.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.
    
    参数:
    
    cssStylesheetURLs - array of CSS stylesheet URLs to add, which may be empty
  - getClientSideXSLTStylesheetURLs
```
public java.lang.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(java.lang.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.
    
    参数:
    
    clientSideXSLTStylesheetURLs - array of URLs to use, which may be empty.
  - addClientSideXSLTStylesheetURLs
```
public void addClientSideXSLTStylesheetURLs(java.lang.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.
    
    参数:
    
    clientSideXSLTStylesheetURLs - array of URLs to append, which may be empty.
  - getStylesheets
```
public javax.xml.transform.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(javax.xml.transform.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.
    
    参数:
    
    stylesheets - array of XSLT stylesheets to apply, which may be null. They are applied in the order specified.
  - addStylesheets
```
public void addStylesheets(javax.xml.transform.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.
    
    参数:
    
    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 java.lang.String getCustomMathJaxUrl()
```
  - setCustomMathJaxUrl
```
public void setCustomMathJaxUrl(java.lang.String mathJaxPath)
```

类 WebPageOutputOptions

嵌套类概要

从类继承的嵌套类/接口 uk.ac.ed.ph.snuggletex.DOMOutputOptions

字段概要

从类继承的字段 uk.ac.ed.ph.snuggletex.DOMOutputOptions

从接口继承的字段 uk.ac.ed.ph.snuggletex.SerializationSpecifier

构造器概要

方法概要

从类继承的方法 uk.ac.ed.ph.snuggletex.XMLStringOutputOptions

从类继承的方法 uk.ac.ed.ph.snuggletex.DOMOutputOptions

从类继承的方法 java.lang.Object

字段详细资料

DEFAULT_CONTENT_TYPE

DEFAULT_LANG

构造器详细资料

WebPageOutputOptions

方法详细资料

getWebPageType

setWebPageType

getContentType

setContentType

getLang

setLang

getTitle

setTitle

isAddingTitleHeading

setAddingTitleHeading

isAddingMathPlayerImport

setAddingMathPlayerImport

getMathPrefRenderer

setMathPrefRenderer

isIncludingStyleElement

setIncludingStyleElement

getCSSStylesheetURLs

setCSSStylesheetURLs

addCSSStylesheetURLs

getClientSideXSLTStylesheetURLs

setClientSideXSLTStylesheetURLs

addClientSideXSLTStylesheetURLs

getStylesheets

setStylesheets

addStylesheets

isHtml5

setHtml5

isNoCharsetInContentTypeHeader

setNoCharsetInContentTypeHeader

isMathJax

setMathJax

getCustomMathJaxUrl

setCustomMathJaxUrl