|
Enhydra 3.1.1b1 API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.enhydra.xml.io.OutputOptions
Object that specifies how a HTML or XML file will be formatted.
Note: the pretty-printing options are not yet implemented by the formatters.
Inner Class Summary | |
static class |
OutputOptions.Format
Desired output format enumerated type. |
Field Summary | |
static OutputOptions.Format |
FORMAT_AUTO
Constant indicating format should be determined automatically from examining the document object. |
static OutputOptions.Format |
FORMAT_HTML
Constant indicating HTML format. |
static OutputOptions.Format |
FORMAT_XML
Constant indicating XML format. |
Constructor Summary | |
OutputOptions()
Construct with default values. |
|
OutputOptions(OutputOptions src)
Copy constructor. |
Method Summary | |
void |
createCodeGenerator(java.lang.String varName,
boolean makeReadOnly,
org.enhydra.xml.xmlc.codegen.JavaCode code)
Generate code to create an object with the same attributes as this object. |
boolean |
getDropHtmlSpanIds()
Get the drop HTML SPAN element ids flag. |
java.lang.String |
getEncoding()
Get the encoding. |
OutputOptions.Format |
getFormat()
Get the output format for the file. |
int |
getIndentSize()
Get indentation size. |
java.lang.String |
getJavaEncoding()
Deprecated. Use getEncoding() or getMIMEEncoding(). |
java.lang.String |
getMIMEEncoding()
Get the MIME encoding. |
java.lang.String |
getMIMEType()
Get the MIME for an output routine to use. |
boolean |
getOmitAttributeCharEntityRefs()
Get value of flag that enables or disables the use of character entity references in attribute values. |
boolean |
getOmitDocType()
Get flag indicating if the DOCTYPE should be omitted. |
boolean |
getOmitEncoding()
Get flag indicating if encoding should be omitted from the XML header. |
boolean |
getOmitXMLHeader()
Get flag indicating if the XML header should be omitted. |
boolean |
getPreserveSpace()
Get the default space-preservation flag. |
boolean |
getPrettyPrinting()
Get pretty-printing flag. |
java.lang.String |
getPublicId()
Get the public id to use in the DOCUMENT. |
java.lang.String |
getSystemId()
Get the system id to use in the DOCUMENT. |
URLRewriter |
getURLRewriter()
Get the URLRewriter. |
java.lang.String |
getXmlEncoding()
Deprecated. Use getMIMEEncoding(). |
void |
markReadOnly()
Mark the object as read-only. |
void |
setDropHtmlSpanIds(boolean drop)
Set the drop HTML SPAN element ids flag. |
void |
setEncoding(java.lang.String encoding)
Set the encoding. |
void |
setFormat(OutputOptions.Format format)
Set the output format for the file. |
void |
setIndentSize(int size)
Set indentation size. |
void |
setJavaEncoding(java.lang.String newJavaEncoding)
Deprecated. Use setEncoding(). |
void |
setMIMEType(java.lang.String mimeType)
Set the MIME for an output routine to use. |
void |
setOmitAttributeCharEntityRefs(boolean value)
Set value of flag that enables or disables the use of character entity references in attribute values. |
void |
setOmitDocType(boolean omit)
Set flag indicating if the DOCTYPE should be omitted. |
void |
setOmitEncoding(boolean omit)
Set flag indicating if encoding should be omitted from the XML header. |
void |
setOmitXMLHeader(boolean omit)
Set flag indicating if the XML header should be omitted. |
void |
setPreserveSpace(boolean preserve)
Set the default space-preservation flag. |
void |
setPrettyPrinting(boolean enable)
Enable or disable pretty-printing. |
void |
setPublicId(java.lang.String publicId)
Set the public id to use in the DOCUMENT. |
void |
setSystemId(java.lang.String systemId)
Set the system id to use in the DOCUMENT. |
void |
setURLRewriter(URLRewriter urlRewriter)
Set the URLRewriter that all URL attributes will be passed through. |
void |
setXmlEncoding(java.lang.String newXmlEncoding)
Deprecated. Use setEncoding(). |
java.lang.String |
toString()
Convert to a string for debugging. |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
public static final OutputOptions.Format FORMAT_AUTO
public static final OutputOptions.Format FORMAT_HTML
public static final OutputOptions.Format FORMAT_XML
Constructor Detail |
public OutputOptions()
public OutputOptions(OutputOptions src)
Method Detail |
public void markReadOnly()
OutputOptions(OutputOptions)
public void setFormat(OutputOptions.Format format)
public OutputOptions.Format getFormat()
public java.lang.String getEncoding()
public void setEncoding(java.lang.String encoding)
encoding
- The new encoding, or null to clear.public java.lang.String getMIMEEncoding()
public boolean getPrettyPrinting()
public void setPrettyPrinting(boolean enable)
enable
- true to enable, false to disable.public int getIndentSize()
public void setIndentSize(int size)
size
- Number of characters to indent at each level.public boolean getPreserveSpace()
public void setPreserveSpace(boolean preserve)
perserve
- true if preserving space where not otherwise specified
by the documentpublic boolean getOmitXMLHeader()
public void setOmitXMLHeader(boolean omit)
public boolean getOmitDocType()
public void setOmitDocType(boolean omit)
public boolean getOmitEncoding()
public void setOmitEncoding(boolean omit)
public boolean getDropHtmlSpanIds()
public void setDropHtmlSpanIds(boolean drop)
public boolean getOmitAttributeCharEntityRefs()
public void setOmitAttributeCharEntityRefs(boolean value)
getOmitAttributeCharEntityRefs()
public void setURLRewriter(URLRewriter urlRewriter)
urlRewriter
- The URLRewriter object, or null to disassociate
any URL rewriter.DocumentInfo
public URLRewriter getURLRewriter()
DocumentInfo
public java.lang.String getPublicId()
public void setPublicId(java.lang.String publicId)
public java.lang.String getSystemId()
public void setSystemId(java.lang.String systemId)
public java.lang.String getMIMEType()
public void setMIMEType(java.lang.String mimeType)
public void createCodeGenerator(java.lang.String varName, boolean makeReadOnly, org.enhydra.xml.xmlc.codegen.JavaCode code)
The following attributes are not generated in the new code:
varName
- Variable or field name of variable to store
the object in. It must already be declared.makeReadOnly
- Should the created object be made read-only?code
- Add generated code to this object.public java.lang.String toString()
public java.lang.String getJavaEncoding()
getEncoding()
,
getMIMEEncoding()
public void setJavaEncoding(java.lang.String newJavaEncoding)
setEncoding(java.lang.String)
public java.lang.String getXmlEncoding()
getMIMEEncoding()
public void setXmlEncoding(java.lang.String newXmlEncoding)
|
Enhydra 3.1.1b1 API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |