DOMOutputOptions (snuggletex-core 1.5.1 API)

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

所有已实现的接口:

java.lang.Cloneable

直接已知子类:

XMLStringOutputOptions
```
public class DOMOutputOptions
extends java.lang.Object
implements java.lang.Cloneable
```
This class is used to specify how you want DOM trees to be built when calling relevant methods in SnuggleSession (e.g. SnuggleSession.buildDOMSubtree(org.w3c.dom.Element)

嵌套类概要

嵌套类
限定符和类型类和说明

static class DOMOutputOptions.ErrorOutputOptions
Enumerates the various options for representing InputErrors in the resulting DOM.

嵌套类
限定符和类型	类和说明
`static class`	`DOMOutputOptions.ErrorOutputOptions` Enumerates the various options for representing `InputError`s in the resulting DOM.

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`DEFAULT_MATHML_PREFIX` Default prefix to use if/when prefixing MathML elements
`static java.lang.String`	`DEFAULT_SNUGGLETEX_XML_PREFIX` Default prefix to use if/when prefixing SnuggleTeX XML elements
`static java.lang.String`	`DEFAULT_XHTML_PREFIX` Default prefix to use if/when prefixing XHTML elements

构造器概要

构造器
构造器和说明

DOMOutputOptions()

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

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`void`	`addDOMPostProcessors(DOMPostProcessor... domPostProcessors)` Appends to the currently specified `DOMPostProcessor` that will be called in turn to "fix up" or modify the raw DOM produced by SnuggleTeX immediately after it has been built.
`java.lang.Object`	`clone()`
`DOMPostProcessor[]`	`getDOMPostProcessors()` Returns the array of `DOMPostProcessor` that will be called in turn to "fix up" or modify the raw DOM produced by SnuggleTeX immediately after it has been built.
`DOMOutputOptions.ErrorOutputOptions`	`getErrorOutputOptions()` Gets the current `DOMOutputOptions.ErrorOutputOptions`, specifying how (and whether) error details should be embedded into the resulting XML.
`java.util.Properties`	`getInlineCSSProperties()` Gets the `Properties` Object that will be used to determine inline CSS properties, if used.
`LinkResolver`	`getLinkResolver()` Gets the currently specified "link resolver" which can fix up any XHTML links created by certain LaTeX inputs.
`java.lang.String`	`getMathMLPrefix()` Gets the prefix to use for MathML elements when `isPrefixingMathML()` returns true.
`java.lang.String`	`getSnuggleXMLPrefix()` Gets the prefix to use for custom SnuggleTeX XML elements when `isPrefixingSnuggleXML()` returns true.
`java.lang.String`	`getXHTMLPrefix()` Gets the prefix to use for XHTML elements when `isPrefixingXHTML()` returns true.
`boolean`	`isAddingMathAnnotations()` 已过时。 Use `isAddingMathSourceAnnotations()` instead
`boolean`	`isAddingMathSourceAnnotations()` Returns whether the MathML `math` elements generated by SnuggleTeX should be annotated with the LaTeX input used to generate them.
`boolean`	`isApplyingFirefox3SemanticsWorkaround()` Returns whether we should wrap "display math" MathML content within an additional <mstyle displaystyle="true">....
`boolean`	`isInliningCSS()` Get whether CSS styling is being inlined via `style` attributes or not.
`boolean`	`isMathVariantMapping()` Returns whether we should perform automatic mappings of (safe) Unicode characters when applying "stylings" like `\\mathcal` and `\\mathbb`.
`boolean`	`isPrefixingMathML()` Returns whether MathML elements should be prefixed or not.
`boolean`	`isPrefixingSnuggleXML()` Returns whether custom SnuggleTeX XML elements should be prefixed or not.
`boolean`	`isPrefixingXHTML()` Returns whether XHTML elements should be prefixed or not.
`void`	`setAddingMathAnnotations(boolean addingMathSourceAnnotations)` 已过时。 Use `setAddingMathSourceAnnotations(boolean)` instead
`void`	`setAddingMathSourceAnnotations(boolean addingMathSourceAnnotations)` Sets whether the MathML `math` elements generated by SnuggleTeX should be annotated with the LaTeX input used to generate them.
`void`	`setApplyingFirefox3SemanticsWorkaround(boolean applyingFirefox3SemanticsWorkaround)` Specifies whether we should wrap "display math" MathML content within an additional <mstyle displaystyle="true">....
`void`	`setDOMPostProcessors(DOMPostProcessor... domPostProcessors)` Sets the array of `DOMPostProcessor` that will be called in turn to "fix up" or modify the raw DOM produced by SnuggleTeX immediately after it has been built.
`void`	`setErrorOutputOptions(DOMOutputOptions.ErrorOutputOptions errorOutputOptions)` Sets the current `DOMOutputOptions.ErrorOutputOptions`, specifying how (and whether) error details should be embedded into the resulting XML.
`void`	`setInlineCSSProperties(java.util.Properties inlineCSSProperties)` Sets the `Properties` Object that will be used to determine inline CSS properties, if used.
`void`	`setInliningCSS(boolean inliningCSS)` Set whether CSS styling is to be inlined via `style` attributes or not.
`void`	`setLinkResolver(LinkResolver linkResolver)` Sets the "link resolver" that will be given a chance to fix up any XHTML links created by certain LaTeX inputs.
`void`	`setMathMLPrefix(java.lang.String mathMLPrefix)` Sets the prefix to use for MathML elements when `isPrefixingMathML()` returns true.
`void`	`setMathVariantMapping(boolean mathVariantMapping)` Sets whether we should perform automatic mappings of (safe) Unicode characters when applying "stylings" like `\\mathcal` and `\\mathbb`.
`void`	`setPrefixingMathML(boolean prefixingMathML)` Sets whether MathML elements should be prefixed or not.
`void`	`setPrefixingSnuggleXML(boolean prefixingSnuggleXML)` Sets whether custom SnuggleTeX XML elements should be prefixed or not.
`void`	`setPrefixingXHTML(boolean prefixingXHTML)` Sets whether XHTML elements should be prefixed or not.
`void`	`setSnuggleXMLPrefix(java.lang.String snuggleXMLPrefix)` Sets the prefix to use for custom SnuggleTeX XML elements when `isPrefixingSnuggleXML()` returns true.
`void`	`setXHTMLPrefix(java.lang.String xhtmlPrefix)` Sets the prefix to use for XHTML elements when `isPrefixingXHTML()` returns true.

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

- 字段详细资料
  - DEFAULT_XHTML_PREFIX
```
public static final java.lang.String DEFAULT_XHTML_PREFIX
```
    Default prefix to use if/when prefixing XHTML elements
    
    另请参阅:
    
    常量字段值
  - DEFAULT_MATHML_PREFIX
```
public static final java.lang.String DEFAULT_MATHML_PREFIX
```
    Default prefix to use if/when prefixing MathML elements
    
    另请参阅:
    
    常量字段值
  - DEFAULT_SNUGGLETEX_XML_PREFIX
```
public static final java.lang.String DEFAULT_SNUGGLETEX_XML_PREFIX
```
    Default prefix to use if/when prefixing SnuggleTeX XML elements
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - DOMOutputOptions
```
public DOMOutputOptions()
```
- 方法详细资料
  - getErrorOutputOptions
```
public DOMOutputOptions.ErrorOutputOptions getErrorOutputOptions()
```
    Gets the current DOMOutputOptions.ErrorOutputOptions, specifying how (and whether) error details should be embedded into the resulting XML. The default is DOMOutputOptions.ErrorOutputOptions.NO_OUTPUT.
  - setErrorOutputOptions
```
public void setErrorOutputOptions(DOMOutputOptions.ErrorOutputOptions errorOutputOptions)
```
    Sets the current DOMOutputOptions.ErrorOutputOptions, specifying how (and whether) error details should be embedded into the resulting XML.
    
    参数:
    
    errorOutputOptions - new DOMOutputOptions.ErrorOutputOptions, which must not be null.
  - isInliningCSS
```
public boolean isInliningCSS()
```
    Get whether CSS styling is being inlined via style attributes or not. This is useful if your output is going to end up embedded in someone else's page or in a system where you have no control over stylesheets. The default is false.
  - setInliningCSS
```
public void setInliningCSS(boolean inliningCSS)
```
    Set whether CSS styling is to be inlined via style attributes or not. This is useful if your output is going to end up embedded in someone else's page or in a system where you have no control over stylesheets.
    
    参数:
    
    inliningCSS - true to inline CSS, false otherwise
  - getInlineCSSProperties
```
public java.util.Properties getInlineCSSProperties()
```
    Gets the Properties Object that will be used to determine inline CSS properties, if used. If null, the default CSS supplied within SnuggleTeX will be used. Default is null.
  - setInlineCSSProperties
```
public void setInlineCSSProperties(java.util.Properties inlineCSSProperties)
```
    Sets the Properties Object that will be used to determine inline CSS properties, if used. If null, the default CSS supplied within SnuggleTeX will be used.
    
    参数:
    
    inlineCSSProperties - Properties file used to determine inline CSS properties, which should be null if you want to use the SnuggleTeX defaults.
  - isPrefixingXHTML
```
public boolean isPrefixingXHTML()
```
    Returns whether XHTML elements should be prefixed or not. Default is false.
  - setPrefixingXHTML
```
public void setPrefixingXHTML(boolean prefixingXHTML)
```
    Sets whether XHTML elements should be prefixed or not.
    
    参数:
    
    prefixingXHTML - true to prefix XHTML elements, false otherwise.
  - getXHTMLPrefix
```
public java.lang.String getXHTMLPrefix()
```
    Gets the prefix to use for XHTML elements when isPrefixingXHTML() returns true. Default is DEFAULT_XHTML_PREFIX.
  - setXHTMLPrefix
```
public void setXHTMLPrefix(java.lang.String xhtmlPrefix)
```
    Sets the prefix to use for XHTML elements when isPrefixingXHTML() returns true.
    
    参数:
    
    xhtmlPrefix - desired prefix, which must be non-null and a valid XML NCName.
  - isPrefixingMathML
```
public boolean isPrefixingMathML()
```
    Returns whether MathML elements should be prefixed or not. Default is false.
  - setPrefixingMathML
```
public void setPrefixingMathML(boolean prefixingMathML)
```
    Sets whether MathML elements should be prefixed or not.
    
    参数:
    
    prefixingMathML - true to prefix MathML elements, false otherwise.
  - getMathMLPrefix
```
public java.lang.String getMathMLPrefix()
```
    Gets the prefix to use for MathML elements when isPrefixingMathML() returns true. Default is DEFAULT_MATHML_PREFIX.
  - setMathMLPrefix
```
public void setMathMLPrefix(java.lang.String mathMLPrefix)
```
    Sets the prefix to use for MathML elements when isPrefixingMathML() returns true.
    
    参数:
    
    mathMLPrefix - desired prefix, which must be non-null and a valid XML NCName.
  - isPrefixingSnuggleXML
```
public boolean isPrefixingSnuggleXML()
```
    Returns whether custom SnuggleTeX XML elements should be prefixed or not. Default is false.
  - setPrefixingSnuggleXML
```
public void setPrefixingSnuggleXML(boolean prefixingSnuggleXML)
```
    Sets whether custom SnuggleTeX XML elements should be prefixed or not.
    
    参数:
    
    prefixingSnuggleXML - true to prefix custom SnuggleTeX XML elements, false otherwise.
  - getSnuggleXMLPrefix
```
public java.lang.String getSnuggleXMLPrefix()
```
    Gets the prefix to use for custom SnuggleTeX XML elements when isPrefixingSnuggleXML() returns true. Default is DEFAULT_SNUGGLETEX_XML_PREFIX.
  - setSnuggleXMLPrefix
```
public void setSnuggleXMLPrefix(java.lang.String snuggleXMLPrefix)
```
    Sets the prefix to use for custom SnuggleTeX XML elements when isPrefixingSnuggleXML() returns true.
    
    参数:
    
    snuggleXMLPrefix - desired prefix, which must be non-null and a valid XML NCName.
  - isAddingMathSourceAnnotations
```
public boolean isAddingMathSourceAnnotations()
```
    Returns whether the MathML math elements generated by SnuggleTeX should be annotated with the LaTeX input used to generate them. Default is false.
  - setAddingMathSourceAnnotations
```
public void setAddingMathSourceAnnotations(boolean addingMathSourceAnnotations)
```
    Sets whether the MathML math elements generated by SnuggleTeX should be annotated with the LaTeX input used to generate them.
    
    参数:
    
    addingMathSourceAnnotations - set true to include source annotations, false otherwise.
  - isAddingMathAnnotations
```
@Deprecated
public boolean isAddingMathAnnotations()
```
    已过时。 Use isAddingMathSourceAnnotations() instead
  - setAddingMathAnnotations
```
@Deprecated
public void setAddingMathAnnotations(boolean addingMathSourceAnnotations)
```
    已过时。 Use setAddingMathSourceAnnotations(boolean) instead
  - isApplyingFirefox3SemanticsWorkaround
```
public boolean isApplyingFirefox3SemanticsWorkaround()
```
    Returns whether we should wrap "display math" MathML content within an additional <mstyle displaystyle="true">....</mstyle> wrapper when generating annotated MathML when isAddingMathSourceAnnotations() returns true.
    This is a workaround for Bug 468059 which first seemed to appear in Firefox 3 and MathML within semantics elements to effectively ignore any display="block" attribute on the enclosing MathML element.
    This property is ignored if isAddingMathSourceAnnotations() returns false.
    Use this if having annotations and good rendering in Firefox 3 is important to you.
    
    返回:
    
    true if applying the workaround described above when, false otherwise.
    
    从以下版本开始:
    
    1.2.1
  - setApplyingFirefox3SemanticsWorkaround
```
public void setApplyingFirefox3SemanticsWorkaround(boolean applyingFirefox3SemanticsWorkaround)
```
    Specifies whether we should wrap "display math" MathML content within an additional <mstyle displaystyle="true">....</mstyle> wrapper when generating annotated MathML when isAddingMathSourceAnnotations() returns true.
    This is a workaround for Bug 468059 which first seemed to appear in Firefox 3 and MathML within semantics elements to effectively ignore any display="block" attribute on the enclosing MathML element.
    This property is ignored if isAddingMathSourceAnnotations() returns false.
    Use this if having annotations and good rendering in Firefox 3 is important to you.
    
    参数:
    
    applyingFirefox3SemanticsWorkaround - true to applying the workaround described above when, false otherwise.
    
    从以下版本开始:
    
    1.2.1
  - isMathVariantMapping
```
public boolean isMathVariantMapping()
```
    Returns whether we should perform automatic mappings of (safe) Unicode characters when applying "stylings" like \\mathcal and \\mathbb. Doing this can help if you don't have control over CSS and if clients may not have appropriate fonts installed as it forces the mapping of certain characters to glyphs that may be available.
    (Firefox by default does not change fonts for these cases as it is not clear what font to map to so setting this to true can help with some characters.)
    Default is false.
  - setMathVariantMapping
```
public void setMathVariantMapping(boolean mathVariantMapping)
```
    Sets whether we should perform automatic mappings of (safe) Unicode characters when applying "stylings" like \\mathcal and \\mathbb. Doing this can help if you don't have control over CSS and if clients may not have appropriate fonts installed as it forces the mapping of certain characters to glyphs that may be available.
    (Firefox by default does not change fonts for these cases as it is not clear what font to map to so setting this to true can help with some characters.)
    
    参数:
    
    mathVariantMapping - set true to perform mappings, false otherwise.
  - getDOMPostProcessors
```
public DOMPostProcessor[] getDOMPostProcessors()
```
    Returns the array of DOMPostProcessor that will be called in turn to "fix up" or modify the raw DOM produced by SnuggleTeX immediately after it has been built.
    The default is null, which is treated the same as an empty array here.
    One use of this is by registering a DownConvertingPostProcessor, which will attempt to "down-convert" simple MathML expressions into (X)HTML equivalents. For example, simple linear expressions and simple sub/superscripts can often be converted to acceptable XHTML alternatives. Any expressions deemed too complex to be down-converted are kept as MathML.
    The SnuggleTeX Up-Conversion module also includes an "UpConvertingPostProcessor" that may be used here as well.
    
    另请参阅:
    
    DownConvertingPostProcessor
  - setDOMPostProcessors
```
public void setDOMPostProcessors(DOMPostProcessor... domPostProcessors)
```
    Sets the array of DOMPostProcessor that will be called in turn to "fix up" or modify the raw DOM produced by SnuggleTeX immediately after it has been built.
    One use of this is by registering a DownConvertingPostProcessor, which will attempt to "down-convert" simple MathML expressions into (X)HTML equivalents. For example, simple linear expressions and simple sub/superscripts can often be converted to acceptable XHTML alternatives. Any expressions deemed too complex to be down-converted are kept as MathML.
    The SnuggleTeX Up-Conversion module also includes an "UpConvertingPostProcessor" that may be used here as well.
    
    参数:
    
    domPostProcessors - array of DOMPostProcessor to use, which may be empty.
    
    另请参阅:
    
    DownConvertingPostProcessor
  - addDOMPostProcessors
```
public void addDOMPostProcessors(DOMPostProcessor... domPostProcessors)
```
    Appends to the currently specified DOMPostProcessor that will be called in turn to "fix up" or modify the raw DOM produced by SnuggleTeX immediately after it has been built.
    
    参数:
    
    domPostProcessors - array of DOMPostProcessor to append to currently specified DOMPostProcessors, which may be empty.
    
    另请参阅:
    
    DownConvertingPostProcessor
  - getLinkResolver
```
public LinkResolver getLinkResolver()
```
    Gets the currently specified "link resolver" which can fix up any XHTML links created by certain LaTeX inputs. Default is null, which does nothing.
  - setLinkResolver
```
public void setLinkResolver(LinkResolver linkResolver)
```
    Sets the "link resolver" that will be given a chance to fix up any XHTML links created by certain LaTeX inputs.
    
    参数:
    
    linkResolver - new LinkResolver to use, which may be null to indicate you want links left as-is.
  - clone
```
public java.lang.Object clone()
```
    覆盖:
    
    clone 在类中 java.lang.Object

类 DOMOutputOptions

嵌套类概要

字段概要

构造器概要

方法概要

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

字段详细资料

DEFAULT_XHTML_PREFIX

DEFAULT_MATHML_PREFIX

DEFAULT_SNUGGLETEX_XML_PREFIX

构造器详细资料

DOMOutputOptions

方法详细资料

getErrorOutputOptions

setErrorOutputOptions

isInliningCSS

setInliningCSS

getInlineCSSProperties

setInlineCSSProperties

isPrefixingXHTML

setPrefixingXHTML

getXHTMLPrefix

setXHTMLPrefix

isPrefixingMathML

setPrefixingMathML

getMathMLPrefix

setMathMLPrefix

isPrefixingSnuggleXML

setPrefixingSnuggleXML

getSnuggleXMLPrefix

setSnuggleXMLPrefix

isAddingMathSourceAnnotations

setAddingMathSourceAnnotations

isAddingMathAnnotations

setAddingMathAnnotations

isApplyingFirefox3SemanticsWorkaround

setApplyingFirefox3SemanticsWorkaround

isMathVariantMapping

setMathVariantMapping

getDOMPostProcessors

setDOMPostProcessors

addDOMPostProcessors

getLinkResolver

setLinkResolver

clone