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

   1 {
   2   "name" : "Roo.htmleditor.Block",
   3   "augments" : [],
   4   "childClasses" : {  },
   5   "tree_children" : [],
   6   "tree_parent" : [],
   7   "desc" : "Base class for html editor blocks - do not use it directly .. extend it..",
   8   "isSingleton" : false,
   9   "isStatic" : false,
  10   "isBuiltin" : false,
  11   "isAbstract" : false,
  12   "isBuilderTop" : false,
  13   "memberOf" : "Block",
  14   "example" : "",
  15   "deprecated" : "",
  16   "since" : "",
  17   "see" : "",
  18   "params" : [
  19     {
  20       "name" : "config",
  21       "type" : "Object",
  22       "desc" : "Configuration options",
  23       "isOptional" : false
  24     }
  25   ],
  26   "returns" : [],
  27   "throws" : "",
  28   "requires" : "",
  29   "config" : [
  30     {
  31       "name" : "Context",
  32       "type" : "Object",
  33       "desc" : "menu - see Roo.form.HtmlEditor.ToolbarContext",
  34       "memberOf" : "",
  35       "isOptional" : false,
  36       "optvalues" : []
  37     },
  38     {
  39       "name" : "friendly_name",
  40       "type" : "String",
  41       "desc" : "the name that appears in the context bar about this block",
  42       "memberOf" : "",
  43       "isOptional" : false,
  44       "optvalues" : []
  45     },
  46     {
  47       "name" : "node",
  48       "type" : "DomElement",
  49       "desc" : "The node to apply stuff to.",
  50       "memberOf" : "",
  51       "isOptional" : false,
  52       "optvalues" : []
  53     }
  54   ],
  55   "methods" : [
  56     {
  57       "name" : "getVal",
  58       "type" : "function",
  59       "desc" : "used by readEleemnt to extract data from a node\nmay need improving as it's pretty basic",
  60       "sig" : "(node, tag, attribute, style)",
  61       "static" : false,
  62       "memberOf" : "",
  63       "isStatic" : false,
  64       "isConstructor" : false,
  65       "isPrivate" : false,
  66       "example" : "",
  67       "deprecated" : "",
  68       "since" : "",
  69       "see" : "",
  70       "exceptions" : "",
  71       "requires" : "",
  72       "params" : [
  73         {
  74           "name" : "node",
  75           "type" : "DomElement",
  76           "desc" : "",
  77           "isOptional" : false
  78         },
  79         {
  80           "name" : "tag",
  81           "type" : "String",
  82           "desc" : "- tag to find, eg. IMG ?? might be better to use DomQuery ?",
  83           "isOptional" : false
  84         },
  85         {
  86           "name" : "attribute",
  87           "type" : "String",
  88           "desc" : "(use html - for contents, style for using next param as style, or false to return the node)",
  89           "isOptional" : false
  90         },
  91         {
  92           "name" : "style",
  93           "type" : "String",
  94           "desc" : "the style property - eg. text-align",
  95           "isOptional" : false
  96         }
  97       ],
  98       "returns" : []
  99     },
 100     {
 101       "name" : "toObject",
 102       "type" : "function",
 103       "desc" : "create a DomHelper friendly object - for use with \nRoo.DomHelper.markup / overwrite / etc..\n(override this)",
 104       "sig" : "()\n{\n\n}",
 105       "static" : false,
 106       "memberOf" : "",
 107       "isStatic" : false,
 108       "isConstructor" : false,
 109       "isPrivate" : false,
 110       "example" : "",
 111       "deprecated" : "",
 112       "since" : "",
 113       "see" : "",
 114       "exceptions" : "",
 115       "requires" : "",
 116       "params" : [],
 117       "returns" : []
 118     },
 119     {
 120       "name" : "initAll",
 121       "type" : "function",
 122       "desc" : "initalize all Elements from content that are 'blockable'",
 123       "sig" : "(the)",
 124       "static" : true,
 125       "memberOf" : "",
 126       "isStatic" : true,
 127       "isConstructor" : false,
 128       "isPrivate" : false,
 129       "example" : "",
 130       "deprecated" : "",
 131       "since" : "",
 132       "see" : "",
 133       "exceptions" : "",
 134       "requires" : "",
 135       "params" : [
 136         {
 137           "name" : "the",
 138           "type" : "",
 139           "desc" : "body element",
 140           "isOptional" : false
 141         }
 142       ],
 143       "returns" : []
 144     },
 145     {
 146       "name" : "toHTML",
 147       "type" : "function",
 148       "desc" : "convert to plain HTML for calling insertAtCursor..",
 149       "sig" : "()\n{\n\n}",
 150       "static" : false,
 151       "memberOf" : "",
 152       "isStatic" : false,
 153       "isConstructor" : false,
 154       "isPrivate" : false,
 155       "example" : "",
 156       "deprecated" : "",
 157       "since" : "",
 158       "see" : "",
 159       "exceptions" : "",
 160       "requires" : "",
 161       "params" : [],
 162       "returns" : []
 163     },
 164     {
 165       "name" : "readElement",
 166       "type" : "function",
 167       "desc" : "Read a node that has a 'data-block' property - and extract the values from it.",
 168       "sig" : "(node)",
 169       "static" : false,
 170       "memberOf" : "",
 171       "isStatic" : false,
 172       "isConstructor" : false,
 173       "isPrivate" : false,
 174       "example" : "",
 175       "deprecated" : "",
 176       "since" : "",
 177       "see" : "",
 178       "exceptions" : "",
 179       "requires" : "",
 180       "params" : [
 181         {
 182           "name" : "node",
 183           "type" : "DomElement",
 184           "desc" : "- the node",
 185           "isOptional" : false
 186         }
 187       ],
 188       "returns" : []
 189     },
 190     {
 191       "name" : "factory",
 192       "type" : "function",
 193       "desc" : "factory method to get the block from an element (using cache if necessary)",
 194       "sig" : "(the)",
 195       "static" : true,
 196       "memberOf" : "",
 197       "isStatic" : true,
 198       "isConstructor" : false,
 199       "isPrivate" : false,
 200       "example" : "",
 201       "deprecated" : "",
 202       "since" : "",
 203       "see" : "",
 204       "exceptions" : "",
 205       "requires" : "",
 206       "params" : [
 207         {
 208           "name" : "the",
 209           "type" : "HtmlElement",
 210           "desc" : "dom element",
 211           "isOptional" : false
 212         }
 213       ],
 214       "returns" : []
 215     },
 216     {
 217       "name" : "updateElement",
 218       "type" : "function",
 219       "desc" : "Update a node with values from this object",
 220       "sig" : "(node)",
 221       "static" : false,
 222       "memberOf" : "",
 223       "isStatic" : false,
 224       "isConstructor" : false,
 225       "isPrivate" : false,
 226       "example" : "",
 227       "deprecated" : "",
 228       "since" : "",
 229       "see" : "",
 230       "exceptions" : "",
 231       "requires" : "",
 232       "params" : [
 233         {
 234           "name" : "node",
 235           "type" : "DomElement",
 236           "desc" : "",
 237           "isOptional" : false
 238         }
 239       ],
 240       "returns" : []
 241     }
 242   ],
 243   "events" : []
 244 }