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

   1 {
   2   "name" : "Roo.htmleditor.TidyEntities",
   3   "augments" : [],
   4   "childClasses" : {  },
   5   "tree_children" : [],
   6   "tree_parent" : [],
   7   "desc" : "This is based loosely on tinymce",
   8   "isSingleton" : false,
   9   "isStatic" : true,
  10   "isBuiltin" : false,
  11   "isAbstract" : false,
  12   "isBuilderTop" : false,
  13   "memberOf" : "TidyEntities",
  14   "example" : "",
  15   "deprecated" : "",
  16   "since" : "",
  17   "see" : "",
  18   "params" : [],
  19   "returns" : [],
  20   "throws" : "",
  21   "requires" : "",
  22   "config" : [],
  23   "methods" : [
  24     {
  25       "name" : "getEncodeFunc",
  26       "type" : "function",
  27       "desc" : "Returns an encode function based on the name(s) and it's optional entities.",
  28       "sig" : "(name, entities)",
  29       "static" : true,
  30       "memberOf" : "",
  31       "isStatic" : true,
  32       "isConstructor" : false,
  33       "isPrivate" : false,
  34       "example" : "",
  35       "deprecated" : "",
  36       "since" : "",
  37       "see" : "",
  38       "exceptions" : "",
  39       "requires" : "",
  40       "params" : [
  41         {
  42           "name" : "name",
  43           "type" : "String",
  44           "desc" : "Comma separated list of encoders for example named,numeric.",
  45           "isOptional" : false
  46         },
  47         {
  48           "name" : "entities",
  49           "type" : "String",
  50           "desc" : "Optional parameter with entities to use instead of the built in set.",
  51           "isOptional" : false
  52         }
  53       ],
  54       "returns" : [
  55         {
  56           "name" : "",
  57           "type" : "function",
  58           "desc" : "Encode function to be used."
  59         }
  60       ]
  61     },
  62     {
  63       "name" : "encodeAllRaw",
  64       "type" : "function",
  65       "desc" : "Encoded the specified text with both the attributes and text entities. This function will produce larger text contents\nsince it doesn't know if the context is within a attribute or text node. This was added for compatibility\nand is exposed as the DOMUtils.encode function.",
  66       "sig" : "(text)",
  67       "static" : true,
  68       "memberOf" : "",
  69       "isStatic" : true,
  70       "isConstructor" : false,
  71       "isPrivate" : false,
  72       "example" : "",
  73       "deprecated" : "",
  74       "since" : "",
  75       "see" : "",
  76       "exceptions" : "",
  77       "requires" : "",
  78       "params" : [
  79         {
  80           "name" : "text",
  81           "type" : "String",
  82           "desc" : "Text to encode.",
  83           "isOptional" : false
  84         }
  85       ],
  86       "returns" : [
  87         {
  88           "name" : "",
  89           "type" : "String",
  90           "desc" : "Entity encoded text."
  91         }
  92       ]
  93     },
  94     {
  95       "name" : "encodeRaw",
  96       "type" : "function",
  97       "desc" : "Encodes the specified string using raw entities. This means only the required XML base entities will be encoded.",
  98       "sig" : "(text, attr)",
  99       "static" : true,
 100       "memberOf" : "",
 101       "isStatic" : true,
 102       "isConstructor" : false,
 103       "isPrivate" : false,
 104       "example" : "",
 105       "deprecated" : "",
 106       "since" : "",
 107       "see" : "",
 108       "exceptions" : "",
 109       "requires" : "",
 110       "params" : [
 111         {
 112           "name" : "text",
 113           "type" : "String",
 114           "desc" : "Text to encode.",
 115           "isOptional" : false
 116         },
 117         {
 118           "name" : "attr",
 119           "type" : "Boolean",
 120           "desc" : "Optional flag to specify if the text is attribute contents.",
 121           "isOptional" : false
 122         }
 123       ],
 124       "returns" : [
 125         {
 126           "name" : "",
 127           "type" : "String",
 128           "desc" : "Entity encoded text."
 129         }
 130       ]
 131     },
 132     {
 133       "name" : "encodeNumeric",
 134       "type" : "function",
 135       "desc" : "Encodes the specified string using numeric entities. The core entities will be\nencoded as named ones but all non lower ascii characters will be encoded into numeric entities.",
 136       "sig" : "(text, attr)",
 137       "static" : true,
 138       "memberOf" : "",
 139       "isStatic" : true,
 140       "isConstructor" : false,
 141       "isPrivate" : false,
 142       "example" : "",
 143       "deprecated" : "",
 144       "since" : "",
 145       "see" : "",
 146       "exceptions" : "",
 147       "requires" : "",
 148       "params" : [
 149         {
 150           "name" : "text",
 151           "type" : "String",
 152           "desc" : "Text to encode.",
 153           "isOptional" : false
 154         },
 155         {
 156           "name" : "attr",
 157           "type" : "Boolean",
 158           "desc" : "Optional flag to specify if the text is attribute contents.",
 159           "isOptional" : false
 160         }
 161       ],
 162       "returns" : [
 163         {
 164           "name" : "",
 165           "type" : "String",
 166           "desc" : "Entity encoded text."
 167         }
 168       ]
 169     },
 170     {
 171       "name" : "encodeNamed",
 172       "type" : "function",
 173       "desc" : "Encodes the specified string using named entities. The core entities will be encoded\nas named ones but all non lower ascii characters will be encoded into named entities.",
 174       "sig" : "(text, attr, entities)",
 175       "static" : true,
 176       "memberOf" : "",
 177       "isStatic" : true,
 178       "isConstructor" : false,
 179       "isPrivate" : false,
 180       "example" : "",
 181       "deprecated" : "",
 182       "since" : "",
 183       "see" : "",
 184       "exceptions" : "",
 185       "requires" : "",
 186       "params" : [
 187         {
 188           "name" : "text",
 189           "type" : "String",
 190           "desc" : "Text to encode.",
 191           "isOptional" : false
 192         },
 193         {
 194           "name" : "attr",
 195           "type" : "Boolean",
 196           "desc" : "Optional flag to specify if the text is attribute contents.",
 197           "isOptional" : false
 198         },
 199         {
 200           "name" : "entities",
 201           "type" : "Object",
 202           "desc" : "Optional parameter with entities to use.",
 203           "isOptional" : false
 204         }
 205       ],
 206       "returns" : [
 207         {
 208           "name" : "",
 209           "type" : "String",
 210           "desc" : "Entity encoded text."
 211         }
 212       ]
 213     },
 214     {
 215       "name" : "init",
 216       "type" : "function",
 217       "desc" : "initialize data..",
 218       "sig" : "()\n{\n\n}",
 219       "static" : true,
 220       "memberOf" : "",
 221       "isStatic" : true,
 222       "isConstructor" : false,
 223       "isPrivate" : false,
 224       "example" : "",
 225       "deprecated" : "",
 226       "since" : "",
 227       "see" : "",
 228       "exceptions" : "",
 229       "requires" : "",
 230       "params" : [],
 231       "returns" : []
 232     },
 233     {
 234       "name" : "decode",
 235       "type" : "function",
 236       "desc" : "Decodes the specified string, this will replace entities with raw UTF characters.",
 237       "sig" : "(text)",
 238       "static" : true,
 239       "memberOf" : "",
 240       "isStatic" : true,
 241       "isConstructor" : false,
 242       "isPrivate" : false,
 243       "example" : "",
 244       "deprecated" : "",
 245       "since" : "",
 246       "see" : "",
 247       "exceptions" : "",
 248       "requires" : "",
 249       "params" : [
 250         {
 251           "name" : "text",
 252           "type" : "String",
 253           "desc" : "Text to entity decode.",
 254           "isOptional" : false
 255         }
 256       ],
 257       "returns" : [
 258         {
 259           "name" : "",
 260           "type" : "String",
 261           "desc" : "Entity decoded string."
 262         }
 263       ]
 264     }
 265   ],
 266   "events" : []
 267 }