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     },
  36     {
  37       "name" : "friendly_name",
  38       "type" : "String",
  39       "desc" : "the name that appears in the context bar about this block",
  40       "memberOf" : ""
  41     },
  42     {
  43       "name" : "node",
  44       "type" : "DomElement",
  45       "desc" : "The node to apply stuff to.",
  46       "memberOf" : ""
  47     }
  48   ],
  49   "methods" : [
  50     {
  51       "name" : "getVal",
  52       "type" : "function",
  53       "desc" : "used by readEleemnt to extract data from a node\nmay need improving as it's pretty basic",
  54       "sig" : "(node, tag, attribute, style)",
  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         {
  68           "name" : "node",
  69           "type" : "DomElement",
  70           "desc" : "",
  71           "isOptional" : false
  72         },
  73         {
  74           "name" : "tag",
  75           "type" : "String",
  76           "desc" : "- tag to find, eg. IMG ?? might be better to use DomQuery ?",
  77           "isOptional" : false
  78         },
  79         {
  80           "name" : "attribute",
  81           "type" : "String",
  82           "desc" : "(use html - for contents, style for using next param as style, or false to return the node)",
  83           "isOptional" : false
  84         },
  85         {
  86           "name" : "style",
  87           "type" : "String",
  88           "desc" : "the style property - eg. text-align",
  89           "isOptional" : false
  90         }
  91       ],
  92       "returns" : []
  93     },
  94     {
  95       "name" : "toObject",
  96       "type" : "function",
  97       "desc" : "create a DomHelper friendly object - for use with \nRoo.DomHelper.markup / overwrite / etc..\n(override this)",
  98       "sig" : "()\n{\n\n}",
  99       "static" : false,
 100       "memberOf" : "",
 101       "isStatic" : false,
 102       "isConstructor" : false,
 103       "isPrivate" : false,
 104       "example" : "",
 105       "deprecated" : "",
 106       "since" : "",
 107       "see" : "",
 108       "exceptions" : "",
 109       "requires" : "",
 110       "params" : [],
 111       "returns" : []
 112     },
 113     {
 114       "name" : "initAll",
 115       "type" : "function",
 116       "desc" : "initalize all Elements from content that are 'blockable'",
 117       "sig" : "(the)",
 118       "static" : true,
 119       "memberOf" : "",
 120       "isStatic" : true,
 121       "isConstructor" : false,
 122       "isPrivate" : false,
 123       "example" : "",
 124       "deprecated" : "",
 125       "since" : "",
 126       "see" : "",
 127       "exceptions" : "",
 128       "requires" : "",
 129       "params" : [
 130         {
 131           "name" : "the",
 132           "type" : "",
 133           "desc" : "body element",
 134           "isOptional" : false
 135         }
 136       ],
 137       "returns" : []
 138     },
 139     {
 140       "name" : "toHTML",
 141       "type" : "function",
 142       "desc" : "convert to plain HTML for calling insertAtCursor..",
 143       "sig" : "()\n{\n\n}",
 144       "static" : false,
 145       "memberOf" : "",
 146       "isStatic" : false,
 147       "isConstructor" : false,
 148       "isPrivate" : false,
 149       "example" : "",
 150       "deprecated" : "",
 151       "since" : "",
 152       "see" : "",
 153       "exceptions" : "",
 154       "requires" : "",
 155       "params" : [],
 156       "returns" : []
 157     },
 158     {
 159       "name" : "readElement",
 160       "type" : "function",
 161       "desc" : "Read a node that has a 'data-block' property - and extract the values from it.",
 162       "sig" : "(node)",
 163       "static" : false,
 164       "memberOf" : "",
 165       "isStatic" : false,
 166       "isConstructor" : false,
 167       "isPrivate" : false,
 168       "example" : "",
 169       "deprecated" : "",
 170       "since" : "",
 171       "see" : "",
 172       "exceptions" : "",
 173       "requires" : "",
 174       "params" : [
 175         {
 176           "name" : "node",
 177           "type" : "DomElement",
 178           "desc" : "- the node",
 179           "isOptional" : false
 180         }
 181       ],
 182       "returns" : []
 183     },
 184     {
 185       "name" : "factory",
 186       "type" : "function",
 187       "desc" : "factory method to get the block from an element (using cache if necessary)",
 188       "sig" : "(the)",
 189       "static" : true,
 190       "memberOf" : "",
 191       "isStatic" : true,
 192       "isConstructor" : false,
 193       "isPrivate" : false,
 194       "example" : "",
 195       "deprecated" : "",
 196       "since" : "",
 197       "see" : "",
 198       "exceptions" : "",
 199       "requires" : "",
 200       "params" : [
 201         {
 202           "name" : "the",
 203           "type" : "HtmlElement",
 204           "desc" : "dom element",
 205           "isOptional" : false
 206         }
 207       ],
 208       "returns" : []
 209     },
 210     {
 211       "name" : "updateElement",
 212       "type" : "function",
 213       "desc" : "Update a node with values from this object",
 214       "sig" : "(node)",
 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" : "node",
 229           "type" : "DomElement",
 230           "desc" : "",
 231           "isOptional" : false
 232         }
 233       ],
 234       "returns" : []
 235     }
 236   ],
 237   "events" : []
 238 }