git.roojs.org Git - roojs1/blob - docs/symbols/Roo.htmleditor.TidyWriter.json

   1 {
   2   "name" : "Roo.htmleditor.TidyWriter",
   3   "augments" : [],
   4   "childClasses" : {  },
   5   "tree_children" : [],
   6   "tree_parent" : [],
   7   "desc" : "This is based loosely on tinymce",
   8   "isSingleton" : false,
   9   "isStatic" : false,
  10   "isBuiltin" : false,
  11   "isAbstract" : false,
  12   "isBuilderTop" : false,
  13   "memberOf" : "TidyWriter",
  14   "example" : "",
  15   "deprecated" : "",
  16   "since" : "",
  17   "see" : "",
  18   "params" : [],
  19   "returns" : [],
  20   "throws" : "",
  21   "requires" : "",
  22   "config" : [],
  23   "methods" : [
  24     {
  25       "name" : "doctype",
  26       "type" : "function",
  27       "desc" : "Writes a doctype node such as <!DOCTYPE data>.",
  28       "sig" : "(text)",
  29       "static" : false,
  30       "memberOf" : "",
  31       "isStatic" : false,
  32       "isConstructor" : false,
  33       "isPrivate" : false,
  34       "example" : "",
  35       "deprecated" : "",
  36       "since" : "",
  37       "see" : "",
  38       "exceptions" : "",
  39       "requires" : "",
  40       "params" : [
  41         {
  42           "name" : "text",
  43           "type" : "String",
  44           "desc" : "String to write out inside the doctype.",
  45           "isOptional" : false
  46         }
  47       ],
  48       "returns" : []
  49     },
  50     {
  51       "name" : "reset",
  52       "type" : "function",
  53       "desc" : "Resets the internal buffer if one wants to reuse the writer.",
  54       "sig" : "()\n{\n\n}",
  55       "static" : false,
  56       "memberOf" : "",
  57       "isStatic" : false,
  58       "isConstructor" : false,
  59       "isPrivate" : false,
  60       "example" : "",
  61       "deprecated" : "",
  62       "since" : "",
  63       "see" : "",
  64       "exceptions" : "",
  65       "requires" : "",
  66       "params" : [],
  67       "returns" : []
  68     },
  69     {
  70       "name" : "text",
  71       "type" : "function",
  72       "desc" : "Writes a text node.\n\nIn pre - we should not mess with the contents.",
  73       "sig" : "(text, raw)",
  74       "static" : false,
  75       "memberOf" : "",
  76       "isStatic" : false,
  77       "isConstructor" : false,
  78       "isPrivate" : false,
  79       "example" : "",
  80       "deprecated" : "",
  81       "since" : "",
  82       "see" : "",
  83       "exceptions" : "",
  84       "requires" : "",
  85       "params" : [
  86         {
  87           "name" : "text",
  88           "type" : "String",
  89           "desc" : "String to write out.",
  90           "isOptional" : false
  91         },
  92         {
  93           "name" : "raw",
  94           "type" : "Boolean",
  95           "desc" : "Optional raw state if true the contents wont get encoded.",
  96           "isOptional" : false
  97         }
  98       ],
  99       "returns" : []
 100     },
 101     {
 102       "name" : "getContent",
 103       "type" : "function",
 104       "desc" : "Returns the contents that got serialized.",
 105       "sig" : "()\n{\n\n}",
 106       "static" : false,
 107       "memberOf" : "",
 108       "isStatic" : false,
 109       "isConstructor" : false,
 110       "isPrivate" : false,
 111       "example" : "",
 112       "deprecated" : "",
 113       "since" : "",
 114       "see" : "",
 115       "exceptions" : "",
 116       "requires" : "",
 117       "params" : [],
 118       "returns" : [
 119         {
 120           "name" : "",
 121           "type" : "String",
 122           "desc" : "HTML contents that got written down."
 123         }
 124       ]
 125     },
 126     {
 127       "name" : "comment",
 128       "type" : "function",
 129       "desc" : "Writes a comment node such as <!-- Comment -->.",
 130       "sig" : "(text)",
 131       "static" : false,
 132       "memberOf" : "",
 133       "isStatic" : false,
 134       "isConstructor" : false,
 135       "isPrivate" : false,
 136       "example" : "",
 137       "deprecated" : "",
 138       "since" : "",
 139       "see" : "",
 140       "exceptions" : "",
 141       "requires" : "",
 142       "params" : [
 143         {
 144           "name" : "text",
 145           "type" : "String",
 146           "desc" : "String to write out inside the comment.",
 147           "isOptional" : false
 148         }
 149       ],
 150       "returns" : []
 151     },
 152     {
 153       "name" : "end",
 154       "type" : "function",
 155       "desc" : "Writes the a end element such as </p>.",
 156       "sig" : "(name)",
 157       "static" : false,
 158       "memberOf" : "",
 159       "isStatic" : false,
 160       "isConstructor" : false,
 161       "isPrivate" : false,
 162       "example" : "",
 163       "deprecated" : "",
 164       "since" : "",
 165       "see" : "",
 166       "exceptions" : "",
 167       "requires" : "",
 168       "params" : [
 169         {
 170           "name" : "name",
 171           "type" : "String",
 172           "desc" : "Name of the element.",
 173           "isOptional" : false
 174         }
 175       ],
 176       "returns" : []
 177     },
 178     {
 179       "name" : "pi",
 180       "type" : "function",
 181       "desc" : "Writes a PI node such as <?xml attr=\"value\" ?>.",
 182       "sig" : "(name, text)",
 183       "static" : false,
 184       "memberOf" : "",
 185       "isStatic" : false,
 186       "isConstructor" : false,
 187       "isPrivate" : false,
 188       "example" : "",
 189       "deprecated" : "",
 190       "since" : "",
 191       "see" : "",
 192       "exceptions" : "",
 193       "requires" : "",
 194       "params" : [
 195         {
 196           "name" : "name",
 197           "type" : "String",
 198           "desc" : "Name of the pi.",
 199           "isOptional" : false
 200         },
 201         {
 202           "name" : "text",
 203           "type" : "String",
 204           "desc" : "String to write out inside the pi.",
 205           "isOptional" : false
 206         }
 207       ],
 208       "returns" : []
 209     },
 210     {
 211       "name" : "start",
 212       "type" : "function",
 213       "desc" : "Writes the a start element such as <p id=\"a\">.",
 214       "sig" : "(name, attrs, empty)",
 215       "static" : false,
 216       "memberOf" : "",
 217       "isStatic" : false,
 218       "isConstructor" : false,
 219       "isPrivate" : false,
 220       "example" : "",
 221       "deprecated" : "",
 222       "since" : "",
 223       "see" : "",
 224       "exceptions" : "",
 225       "requires" : "",
 226       "params" : [
 227         {
 228           "name" : "name",
 229           "type" : "String",
 230           "desc" : "Name of the element.",
 231           "isOptional" : false
 232         },
 233         {
 234           "name" : "attrs",
 235           "type" : "Array",
 236           "desc" : "Optional attribute array or undefined if it hasn't any.",
 237           "isOptional" : false
 238         },
 239         {
 240           "name" : "empty",
 241           "type" : "Boolean",
 242           "desc" : "Optional empty state if the tag should end like <br />.",
 243           "isOptional" : false
 244         }
 245       ],
 246       "returns" : []
 247     },
 248     {
 249       "name" : "cdata",
 250       "type" : "function",
 251       "desc" : "Writes a cdata node such as <![CDATA[data]]>.",
 252       "sig" : "(text)",
 253       "static" : false,
 254       "memberOf" : "",
 255       "isStatic" : false,
 256       "isConstructor" : false,
 257       "isPrivate" : false,
 258       "example" : "",
 259       "deprecated" : "",
 260       "since" : "",
 261       "see" : "",
 262       "exceptions" : "",
 263       "requires" : "",
 264       "params" : [
 265         {
 266           "name" : "text",
 267           "type" : "String",
 268           "desc" : "String to write out inside the cdata.",
 269           "isOptional" : false
 270         }
 271       ],
 272       "returns" : []
 273     }
 274   ],
 275   "events" : []
 276 }