1 /*global $k*/ 2 3 /** 4 * @class SAX interface for writing XML. An XMLWriter is created by sending xmlWriter() to a document. 5 **/ 6 $k.XMLWriter = function() { }; 7 8 /** 9 * Writes an attribute of a tag to the document 10 * 11 * @function 12 * @param {string} localName Local name of the attribute 13 * @param {string} value Value of the attribute 14 * @param {string} [prefix] Namespace prefix. The writer does not check if it is bound to a namespace 15 * @throws {$k.exception.XMLError} If writing the attribute is not possible 16 **/ 17 $k.XMLWriter.prototype.attribute = function(localName, value, prefix) { }; 18 19 /** 20 * Writes a CDATA section to the document 21 * 22 * @function 23 * @param {string} characters 24 * @throws {$k.exception.XMLError} If writing the CData is not possible 25 **/ 26 $k.XMLWriter.prototype.cdata = function(characters) { }; 27 28 /** 29 * Writes a string to the document 30 * 31 * @function 32 * @param {string} characters 33 * @throws {$k.exception.XMLError} If writing the string is not possible 34 **/ 35 $k.XMLWriter.prototype.characters = function(characters) { }; 36 37 /** 38 * Writes a comment to the document 39 * 40 * @function 41 * @param {string} comment 42 * @throws {$k.exception.XMLError} If writing the comment is not possible 43 **/ 44 $k.XMLWriter.prototype.comment = function(comment) { }; 45 46 /** 47 * Write the default namespace of the current tag and its children 48 * 49 * @function 50 * @param {string} namespace 51 * @throws {$k.exception.XMLError} If writing the namespace is not possible 52 **/ 53 $k.XMLWriter.prototype.defaultNamespace = function(namespace) { }; 54 55 /** 56 * Closes the currently opened tag 57 * 58 * @function 59 * @throws {$k.exception.XMLError} If closing the tag is not possible 60 **/ 61 $k.XMLWriter.prototype.endElement = function() { }; 62 63 /** 64 * Writes a string to the document without any escaping 65 * 66 * @function 67 * @param {string} characters 68 * @throws {$k.exception.XMLError} If writing the string is not possible 69 **/ 70 $k.XMLWriter.prototype.print = function(characters) { }; 71 72 /** 73 * Writes a processing instruction to the document 74 * 75 * @function 76 * @param {string} target 77 * @param {string} data 78 * @throws {$k.exception.XMLError} If writing the comment is not possible 79 **/ 80 $k.XMLWriter.prototype.processingInstruction = function(target, data) { }; 81 82 /** 83 * Enable/disable automatic indentation of the XML tags. 84 * Default is true 85 * 86 * @function 87 * @param {boolean} enableIndentation 88 **/ 89 $k.XMLWriter.prototype.setIndent = function(enableIndentation) { }; 90 91 /** 92 * Sets the prefix the uri is bound to 93 * 94 * @function 95 * @param {string} prefix 96 * @param {string} namespace 97 **/ 98 $k.XMLWriter.prototype.setPrefix = function(prefix, namespace) { }; 99 100 /** 101 * Writes a start tag to the document 102 * 103 * @function 104 * @param {string} localName Local name of the tag 105 * @param {string} [prefix] Namespace prefix. The writer does not check if it is bound to a namespace 106 * @throws {$k.exception.XMLError} If writing the tag is not possible 107 **/ 108 $k.XMLWriter.prototype.startElement = function(localName, prefix) { }; 109 110