| Package | com.yworks.io.graphml.writer |
| Class | public class DefaultXmlWriter |
| Inheritance | DefaultXmlWriter  Object |
| Implements | IXmlWriter |
IXmlWriter interface.
| Property | Defined By | ||
|---|---|---|---|
| document : XML [read-only]
The XML to be written to. | DefaultXmlWriter | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a new Instance. | DefaultXmlWriter | ||
addNamespace(ns:Namespace):void
Add a namespace declaration to the root element of the output. | DefaultXmlWriter | ||
appendChild(xml:XML):void
Append an xml element to the current element. | DefaultXmlWriter | ||
lookup(type:Class):Object | DefaultXmlWriter | ||
writeAttribute(localName:String, value:*, ns:Namespace = null):IXmlWriter
Write a Xml attribute node. | DefaultXmlWriter | ||
writeComment(comment:String):IXmlWriter
Write a Xml comment node
| DefaultXmlWriter | ||
Close the output. | DefaultXmlWriter | ||
Close a XML element previously opened with writeStartElement. | DefaultXmlWriter | ||
writePlainText(s:String):IXmlWriter | DefaultXmlWriter | ||
writeProcessingInstruction(target:String, pi:String):IXmlWriter
Write a Xml processing instruction
| DefaultXmlWriter | ||
writeStartDocument(docTag:String, ns:Namespace = null):IXmlWriter
Begin the output process
| DefaultXmlWriter | ||
writeStartElement(localName:String, ns:Namespace = null):IXmlWriter | DefaultXmlWriter | ||
writeText(s:String):IXmlWriter
Writes the string and wraps it in a CDATA section, if necessary. | DefaultXmlWriter | ||
| document | property |
document:XML [read-only]
The XML to be written to.
public function get document():XML| DefaultXmlWriter | () | Constructor |
public function DefaultXmlWriter()Creates a new Instance.
| addNamespace | () | method |
public function addNamespace(ns:Namespace):voidAdd a namespace declaration to the root element of the output.
Parameters
ns:Namespace — the namespace to be added.
|
| appendChild | () | method |
public function appendChild(xml:XML):voidAppend an xml element to the current element.
Parameters
xml:XML — The xml element to be added.
|
| lookup | () | method |
public function lookup(type:Class):ObjectParameters
type:Class |
Object |
| writeAttribute | () | method |
public function writeAttribute(localName:String, value:*, ns:Namespace = null):IXmlWriterWrite a Xml attribute node.
The attribute is attached to the closest open Xml element that has
been started with writeStartElement
If the prefix and/or namespace arguments are null, no namespace and prefix is used.
Parameters
localName:String — The local name of the attribute
| |
value:* — The value of this attribute
| |
ns:Namespace (default = null) |
IXmlWriter — The writer instance, to allow for output chaining
|
| writeComment | () | method |
public function writeComment(comment:String):IXmlWriterWrite a Xml comment node
Parameters
comment:String — The content of the comment
|
IXmlWriter — the writer instance, to allow for output chaining
|
| writeEndDocument | () | method |
public function writeEndDocument():IXmlWriterClose the output.
Attemps to write to the same document after this method has been called will have undefined results
ReturnsIXmlWriter — the writer instance, to allow for output chaining
|
| writeEndElement | () | method |
public function writeEndElement():IXmlWriter
Close a XML element previously opened with writeStartElement.
IXmlWriter — The writer instance, to allow for output chaining.
|
| writePlainText | () | method |
| writeProcessingInstruction | () | method |
public function writeProcessingInstruction(target:String, pi:String):IXmlWriterWrite a Xml processing instruction
Parameters
target:String — the target of the processing instruction (e.g. "xml-stylesheet" in <?xml-stylesheet ..>)
| |
pi:String — the processing instruction data
|
IXmlWriter — the writer instance, to allow for output chaining
|
| writeStartDocument | () | method |
public function writeStartDocument(docTag:String, ns:Namespace = null):IXmlWriterBegin the output process
Parameters
docTag:String | |
ns:Namespace (default = null)null
|
IXmlWriter — the writer instance, to allow for output chaining
|
| writeStartElement | () | method |
public function writeStartElement(localName:String, ns:Namespace = null):IXmlWriterParameters
localName:String | |
ns:Namespace (default = null) |
IXmlWriter |
| writeText | () | method |
public function writeText(s:String):IXmlWriterWrites the string and wraps it in a CDATA section, if necessary. Write a text node.
Parameters
s:String — The content of the text node
|
IXmlWriter — The writer instance, to allow for output chaining
|