|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.icl.saxon.output.OutputDetails
An OutputDetails object holds parameters controlling the generation of output files
Constructor Summary | |
OutputDetails()
Construct a default OutputDetails object |
|
OutputDetails(OutputDetails base)
Construct an OutputDetails object as a copy of an existing OutputDetails object |
Method Summary | |
void |
addCdataElement(int nameCode)
Supply a single output element name that is to be treated as CDATA elements |
void |
addCdataElements(java.util.Vector v)
Supply a list of output element names that are to be treated as CDATA elements |
java.util.Vector |
getCdataElements()
Get the list of elements to be treated as CDATA |
java.lang.String |
getCharacterRepresentation()
Determine the preferred character representation in HTML output |
boolean |
getCloseAfterUse()
Determine whether the Writer should be closed after use |
java.lang.String |
getDoctypePublic()
Get the Public ID of the DOCTYPE declaration |
java.lang.String |
getDoctypeSystem()
Get the System ID of the DOCTYPE declaration |
org.w3c.dom.Node |
getDOMNode()
Get the DOM node to which output should be attached |
Emitter |
getEmitter()
Get the current Emitter |
java.lang.String |
getEncoding()
Get the character encoding |
boolean |
getIncludeHtmlMetaTag()
Determine whether a META tag should be included after the HEAD tag in HTML output |
java.lang.String |
getIndent()
Determine whether indenting is on or off |
int |
getIndentSpaces()
Get number of spaces to indent by |
java.lang.String |
getMediaType()
Get the MIME media type. |
java.lang.String |
getMethod()
Get the output method (html, xml, text etc) |
PreparedStyleSheet |
getNextInChain()
Get the StyleSheet to be used to handle the output of this one |
java.lang.String |
getOmitDeclaration()
Is XML Declaration to be omitted? |
java.io.OutputStream |
getOutputStream()
Get the output stream being used for output |
java.lang.String |
getStandalone()
Is the output "standalone"? |
java.lang.String |
getUserData()
Get the user data (from the saxon:output user-data attribute) |
java.lang.String |
getVersion()
Get the version of the output format, e.g. |
java.io.Writer |
getWriter()
Get the Writer being used for output |
boolean |
isEscaping()
Should special characters be escaped? |
boolean |
isIndenting()
Decide whether indenting is on or off |
void |
setCharacterRepresentation(java.lang.String rep)
Set preferred character representation in HTML output. |
void |
setCloseAfterUse(boolean close)
Indicate whether the Writer should be closed after use |
void |
setDoctypePublic(java.lang.String s)
Set the Public ID to be used in the DOCTYPE declaration |
void |
setDoctypeSystem(java.lang.String s)
Set the System ID to be used in the DOCTYPE declaration |
void |
setDOMNode(org.w3c.dom.Node node)
Set the DOM node to which output should be appended |
void |
setEmitter(Emitter h)
Set the Emitter to be used for output |
void |
setEncoding(java.lang.String s)
Set the encoding. |
void |
setEscaping(boolean b)
Switch on or off escaping of special characters |
void |
setIncludeHtmlMetaTag(boolean yes)
Set whether a META tag should be included after the HEAD tag in HTML output |
void |
setIndent(java.lang.String s)
Set indenting on or off |
void |
setIndentSpaces(int spaces)
Set number of spaces to indent by |
void |
setMediaType(java.lang.String s)
Set the MIME media type, e.g. |
void |
setMethod(java.lang.String s)
Set the method to be used |
void |
setNextInChain(PreparedStyleSheet next)
Set the StyleSheet to be used to handle the output of this one |
void |
setOmitDeclaration(java.lang.String s)
Indicate whether the XML Declaration should be omitted |
void |
setOutputStream(java.io.OutputStream out)
Set the output stream to be used for producing output |
void |
setStandalone(java.lang.String s)
Indicate whether the output document is "standalone" |
void |
setUserData(java.lang.String s)
Set user data (from the saxon:output user-data attribute). |
void |
setVersion(java.lang.String s)
Set the version of the output format, e.g. |
void |
setWriter(java.io.Writer w)
Set the writer to be used for producing output. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public OutputDetails()
public OutputDetails(OutputDetails base)
Method Detail |
public final void setWriter(java.io.Writer w)
public final void setOutputStream(java.io.OutputStream out)
public final void setMethod(java.lang.String s)
s
- the output method: "html", "xml", "text", "fop", or a user-supplied DocumentHandler
or Emitter class namepublic final void setVersion(java.lang.String s)
public final void setIndent(java.lang.String s)
s
- "yes" (indent) or "no" (don't indent)public void setIndentSpaces(int spaces)
public final void setEncoding(java.lang.String s)
public final void setMediaType(java.lang.String s)
public final void setDoctypeSystem(java.lang.String s)
public final void setDoctypePublic(java.lang.String s)
public final void setOmitDeclaration(java.lang.String s)
s
- "yes": omit the declaration; "no": include the declarationpublic final void setStandalone(java.lang.String s)
s
- "yes" or "no"public final void setUserData(java.lang.String s)
s
- the user datapublic final void addCdataElements(java.util.Vector v)
s
- A white-space separated list of element namespublic final void addCdataElement(int nameCode)
namecode
- Integer name code of the relevant elementpublic final void setEscaping(boolean b)
b
- true: special characters are escaped; false: special characters are not escapedpublic final void setEmitter(Emitter h)
public final void setNextInChain(PreparedStyleSheet next)
public final void setCloseAfterUse(boolean close)
public final void setDOMNode(org.w3c.dom.Node node)
public void setIncludeHtmlMetaTag(boolean yes)
public void setCharacterRepresentation(java.lang.String rep)
public final java.io.Writer getWriter()
public final java.io.OutputStream getOutputStream()
public final java.lang.String getMethod()
public final java.lang.String getVersion()
public final java.lang.String getIndent()
public final boolean isIndenting()
public int getIndentSpaces()
public final java.lang.String getEncoding()
public final java.lang.String getMediaType()
public final java.lang.String getDoctypeSystem()
public final java.lang.String getDoctypePublic()
public final java.lang.String getOmitDeclaration()
public final java.lang.String getStandalone()
public final java.lang.String getUserData()
public final java.util.Vector getCdataElements()
public final boolean isEscaping()
public final Emitter getEmitter()
public final PreparedStyleSheet getNextInChain()
public final boolean getCloseAfterUse()
public final org.w3c.dom.Node getDOMNode()
public boolean getIncludeHtmlMetaTag()
public java.lang.String getCharacterRepresentation()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |