XMLStringOutputOptions (snuggletex-core 1.5.1 API)

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

所有已实现的接口:

java.lang.Cloneable, SerializationSpecifier

直接已知子类:

WebPageOutputOptions
```
public class XMLStringOutputOptions
extends DOMOutputOptions
implements SerializationSpecifier
```
Builds on DOMOutputOptions to add in options for configuring how to build an serialized output consisting of an XML (or possibly HTML) String using the relevant methods in SnuggleSession (e.g. SnuggleSession.buildXMLString(XMLStringOutputOptions)).

从以下版本开始:

1.2.0

另请参阅:

DOMOutputOptions, WebPageOutputOptions, WebPageOutputOptionsBuilder

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

字段概要
- 从类继承的字段 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

构造器概要

构造器
构造器和说明

XMLStringOutputOptions()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`java.lang.String`	`getDoctypePublic()` Gets the public identifier to use in the resulting DOCTYPE declaration, as described in `OutputKeys.DOCTYPE_PUBLIC`.
`java.lang.String`	`getDoctypeSystem()` Gets the system identifier to use in the resulting DOCTYPE declaration, as described in `OutputKeys.DOCTYPE_SYSTEM`.
`java.lang.String`	`getEncoding()` Gets the encoding for the resulting serialized XML.
`int`	`getIndent()` Returns the indentation level to use when `isIndenting()` returns true.
`SerializationMethod`	`getSerializationMethod()` Gets the `SerializationMethod` to use when generating the final output.
`boolean`	`isIncludingXMLDeclaration()` Gets whether to include an XML declaration on the resulting output.
`boolean`	`isIndenting()` Returns whether the resulting XML will be indented or not.
`boolean`	`isUsingNamedEntities()` Returns whether to use named entities for certain MathML symbols rather than numeric character references.
`void`	`setDoctypePublic(java.lang.String doctypePublic)` Sets the public identifier to use in the resulting DOCTYPE declaration, as described in `OutputKeys.DOCTYPE_PUBLIC`.
`void`	`setDoctypeSystem(java.lang.String doctypeSystem)` Sets the system identifier to use in the resulting DOCTYPE declaration, as described in `OutputKeys.DOCTYPE_SYSTEM`.
`void`	`setEncoding(java.lang.String encoding)` Sets the encoding for the resulting serialized XML.
`void`	`setIncludingXMLDeclaration(boolean includingXMLDeclaration)` Sets whether to include an XML declaration on the resulting output.
`void`	`setIndent(int indent)` Sets the indentation level to use when `isIndenting()` returns true.
`void`	`setIndenting(boolean indenting)` Sets whether the resulting XML will be indented or not.
`void`	`setSerializationMethod(SerializationMethod serializationMethod)` Sets the `SerializationMethod` to use when generating the final output.
`void`	`setUsingNamedEntities(boolean usingNamedEntities)` Sets whether to use named entities for certain MathML symbols rather than numeric character references.

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

- 构造器详细资料
  - XMLStringOutputOptions
```
public XMLStringOutputOptions()
```
- 方法详细资料
  - getSerializationMethod
```
public SerializationMethod getSerializationMethod()
```
    Gets the SerializationMethod to use when generating the final output.
    Default is SerializationMethod.XML. This must not be null.
    Note that SerializationMethod.XHTML is only supported properly if you are using an XSLT 2.0 processor; otherwise it reverts to SerializationMethod.XML
    
    指定者:
    
    getSerializationMethod 在接口中 SerializationSpecifier
  - setSerializationMethod
```
public void setSerializationMethod(SerializationMethod serializationMethod)
```
    Sets the SerializationMethod to use when generating the final output. This must not be null.
    Note that SerializationMethod.XHTML is only supported properly if you are using an XSLT 2.0 processor; otherwise it reverts to SerializationMethod.XML
    
    指定者:
    
    setSerializationMethod 在接口中 SerializationSpecifier
    
    参数:
    
    serializationMethod - SerializationMethod to use, which must not be null.
  - getEncoding
```
public java.lang.String getEncoding()
```
    Gets the encoding for the resulting serialized XML.
    Default is SerializationSpecifier.DEFAULT_ENCODING.
    
    指定者:
    
    getEncoding 在接口中 SerializationSpecifier
  - setEncoding
```
public void setEncoding(java.lang.String encoding)
```
    Sets the encoding for the resulting serialized XML.
    Must not be null.
    
    指定者:
    
    setEncoding 在接口中 SerializationSpecifier
    
    参数:
    
    encoding - encoding to use, which must be non-null and recognised by the XSLT TransformerFactory that will end up doing the serialization.
  - isIndenting
```
public boolean isIndenting()
```
    Returns whether the resulting XML will be indented or not. (This depends on how clever the underlying XSLT engine will be!)
    Default is false.
    
    指定者:
    
    isIndenting 在接口中 SerializationSpecifier
  - setIndenting
```
public void setIndenting(boolean indenting)
```
    Sets whether the resulting XML will be indented or not. (This depends on how clever the underlying XSLT engine will be!)
    NOTE: The old version of Xalan that comes bundled with Java 6 (and below) appears to be unable to indent output when using setIndenting(boolean) with SerializationMethod.HTML. I have not checked this behaviour with Java 7 (or above). I however recommend using Saxon, or including a newer version of Xalan in the ClassPath.
    
    指定者:
    
    setIndenting 在接口中 SerializationSpecifier
    
    参数:
    
    indenting - true to indent, false otherwise.
  - getIndent
```
public int getIndent()
```
    Returns the indentation level to use when isIndenting() returns true. (This is currently only supported if your underlying XSLT process is either Saxon or Xalan. This will be the case by if you have chosen to either use Saxon or use the default processor that ships with your Java platform.)
    This must be a non-negative integer. The default value is SerializationSpecifier.DEFAULT_INDENT.
    
    指定者:
    
    getIndent 在接口中 SerializationSpecifier
    
    从以下版本开始:
    
    1.2.3
  - setIndent
```
public void setIndent(int indent)
```
    Sets the indentation level to use when isIndenting() returns true. (This is currently only supported if your underlying XSLT process is either Saxon or Xalan. This will be the case by if you have chosen to either use Saxon or use the default processor that ships with your Java platform.)
    This must be a non-negative integer. The default value is SerializationSpecifier.DEFAULT_INDENT.
    
    指定者:
    
    setIndent 在接口中 SerializationSpecifier
    
    从以下版本开始:
    
    1.2.3
  - isIncludingXMLDeclaration
```
public boolean isIncludingXMLDeclaration()
```
    Gets whether to include an XML declaration on the resulting output. Default is false.
    
    指定者:
    
    isIncludingXMLDeclaration 在接口中 SerializationSpecifier
  - setIncludingXMLDeclaration
```
public void setIncludingXMLDeclaration(boolean includingXMLDeclaration)
```
    Sets whether to include an XML declaration on the resulting output.
    
    指定者:
    
    setIncludingXMLDeclaration 在接口中 SerializationSpecifier
    
    参数:
    
    includingXMLDeclaration - true to include an XML declaration, false otherwise.
  - isUsingNamedEntities
```
public boolean isUsingNamedEntities()
```
    Returns whether to use named entities for certain MathML symbols rather than numeric character references.
    Default is false.
    
    指定者:
    
    isUsingNamedEntities 在接口中 SerializationSpecifier
  - setUsingNamedEntities
```
public void setUsingNamedEntities(boolean usingNamedEntities)
```
    Sets whether to use named entities for certain MathML symbols rather than numeric character references.
    Note that this requires an XSLT 2.0-compliant engine (e.g. Saxon, which is in the "full" SnuggleTeX distribution). This option will be silently ignored if you are using an XSLT 1.0 engine, such as the one which typically comes bundled with your JDK.
    (Also note that the resulting XML won't be parseable unless accompanied with a DTD defining the MathML entities!)
    
    指定者:
    
    setUsingNamedEntities 在接口中 SerializationSpecifier
    
    参数:
    
    usingNamedEntities - true to use named entities, false to default to using numeric character references.
  - getDoctypePublic
```
public java.lang.String getDoctypePublic()
```
    Gets the public identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_PUBLIC.
    Default is null
    
    指定者:
    
    getDoctypePublic 在接口中 SerializationSpecifier
  - setDoctypePublic
```
public void setDoctypePublic(java.lang.String doctypePublic)
```
    Sets the public identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_PUBLIC.
    
    指定者:
    
    setDoctypePublic 在接口中 SerializationSpecifier
    
    参数:
    
    doctypePublic - public identifier to use, null for no identifier.
  - getDoctypeSystem
```
public java.lang.String getDoctypeSystem()
```
    Gets the system identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_SYSTEM.
    Default is null
    
    指定者:
    
    getDoctypeSystem 在接口中 SerializationSpecifier
  - setDoctypeSystem
```
public void setDoctypeSystem(java.lang.String doctypeSystem)
```
    Sets the system identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_SYSTEM.
    
    指定者:
    
    setDoctypeSystem 在接口中 SerializationSpecifier
    
    参数:
    
    doctypeSystem - system identifier to use, null for no identifier.

类 XMLStringOutputOptions

嵌套类概要

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

字段概要

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

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

构造器概要

方法概要

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

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

构造器详细资料

XMLStringOutputOptions

方法详细资料

getSerializationMethod

setSerializationMethod

getEncoding

setEncoding

isIndenting

setIndenting

getIndent

setIndent

isIncludingXMLDeclaration

setIncludingXMLDeclaration

isUsingNamedEntities

setUsingNamedEntities

getDoctypePublic

setDoctypePublic

getDoctypeSystem

setDoctypeSystem