X-Git-Url: http://git.roojs.org/?a=blobdiff_plain;f=docs%2Fsymbols%2FRoo.Element.json;fp=docs%2Fsymbols%2FRoo.Element.json;h=e6d45977a1b66fddd5b16bbff26af86019624255;hb=9ff8ded6bbbd258ecd646184ba26020874e2c085;hp=0000000000000000000000000000000000000000;hpb=2542b67d1a0768025056f2f330bfe50b64d1ad38;p=roojs1
diff --git a/docs/symbols/Roo.Element.json b/docs/symbols/Roo.Element.json
new file mode 100644
index 0000000000..e6d45977a1
--- /dev/null
+++ b/docs/symbols/Roo.Element.json
@@ -0,0 +1,4176 @@
+{
+ "name" : "Roo.Element",
+ "augments" : [
+ ],
+ "desc" : "Represents an Element in the DOM.
\nUsage:
\n
\nvar el = Roo.get(\"my-div\");\n\n// or with getEl\nvar el = getEl(\"my-div\");\n\n// or with a DOM element\nvar el = Roo.get(myDivElement);\n
\nUsing Roo.get() or getEl() instead of calling the constructor directly ensures you get the same object\neach call instead of constructing a new one.\nOption Default Description\n--------- -------- ---------------------------------------------\nduration .35 The duration of the animation in seconds\neasing easeOut The YUI easing method\ncallback none A function to execute when the anim completes\nscope this The scope (this) of the callback function\n\nAlso, the Anim object being used for the animation will be set on your options object as \"anim\", which allows you to stop or\nmanipulate the animation. Here's an example:\n
\nvar el = Roo.get(\"my-div\");\n\n// no animation\nel.setWidth(100);\n\n// default animation\nel.setWidth(100, true);\n\n// animation with some options set\nel.setWidth(100, {\n duration: 1,\n callback: this.foo,\n scope: this\n});\n\n// using the \"anim\" property to get the Anim object\nvar opt = {\n duration: 1,\n callback: this.foo,\n scope: this\n};\nel.setWidth(100, opt);\n...\nif(opt.anim.isAnimated()){\n opt.anim.stop();\n}\n
\n Composite (Collections of) Elements\n Value Description\n ----- -----------------------------\n tl The top left corner (default)\n t The center of the top edge\n tr The top right corner\n l The center of the left edge\n c In the center of the element\n r The center of the right edge\n bl The bottom left corner\n b The center of the bottom edge\n br The bottom right corner\n\n Example Usage:\n
\n // align el to other-el using the default positioning (\"tl-bl\", non-constrained)\n el.alignTo(\"other-el\");\n\n // align the top left corner of el with the top right corner of other-el (constrained to viewport)\n el.alignTo(\"other-el\", \"tr?\");\n\n // align the bottom right corner of el with the center left edge of other-el\n el.alignTo(\"other-el\", \"br-l?\");\n\n // align the center of el with the bottom left corner of other-el and\n // adjust the x position by -6 pixels (and the y position by 0)\n el.alignTo(\"other-el\", \"c-bl\", [-6, 0]);\n
",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "element",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element to align to.",
+ "isOptional" : false
+ },
+ {
+ "name" : "position",
+ "type" : "String",
+ "desc" : "The position to align to.",
+ "isOptional" : false
+ },
+ {
+ "name" : "offsets",
+ "type" : "Array",
+ "desc" : "(optional) Offset the positioning by [x, y]",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "insertAfter",
+ "desc" : "Inserts this element after the passed element in the DOM",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The element to insert after",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "hide",
+ "desc" : "Hide this element - Uses display mode to determine whether to use \"display\" or \"visibility\". See {@link #setVisible}.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "setBottom",
+ "desc" : "Sets the element's CSS bottom style.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "bottom",
+ "type" : "String",
+ "desc" : "The bottom CSS property value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "clearPositioning",
+ "desc" : "Clear positioning back to the default when the document was loaded",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "(optional) The value to use for the left,right,top,bottom, defaults to '' (empty string). You could use 'auto'.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "isDisplayed",
+ "desc" : "Returns true if display is not \"none\"",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "desc" : "Show this element - Uses display mode to determine whether to use \"display\" or \"visibility\". See {@link #setVisible}.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "setLeftTop",
+ "desc" : "Quick set left and top adding default units",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "left",
+ "type" : "String",
+ "desc" : "The left CSS property value",
+ "isOptional" : false
+ },
+ {
+ "name" : "top",
+ "type" : "String",
+ "desc" : "The top CSS property value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "child",
+ "desc" : "Selects a single child at any depth below this element based on the passed CSS selector (the selector should not contain an id).",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "selector",
+ "type" : "String",
+ "desc" : "The CSS selector",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnDom",
+ "type" : "Boolean",
+ "desc" : "(optional) True to return the DOM node instead of Roo.Element (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The child Roo.Element (or DOM node if returnDom = true)"
+ }
+ ]
+ },
+ {
+ "name" : "unmask",
+ "desc" : "Removes a previously applied mask. If removeEl is true the mask overlay is destroyed, otherwise\nit is cached for reuse.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "moveTo",
+ "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "X value for new position (coordinates are page-based)",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "Y value for new position (coordinates are page-based)",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) True for the default animation, or a standard Element animation config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "addClassOnOver",
+ "desc" : "Sets up event handlers to add and remove a css class when the mouse is over this element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "className",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "preventFlicker",
+ "type" : "Boolean",
+ "desc" : "(optional) If set to true, it prevents flickering by filtering\nmouseout events for children elements",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "getLeft",
+ "desc" : "Gets the left X coordinate",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "True to get the local css position instead of page coordinate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "isScrollable",
+ "desc" : "Returns true if this element is scrollable.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "boxWrap",
+ "desc" : "Wraps the specified element with a special markup/CSS block that renders by default as a gray container with a\ngradient background, rounded corners and a 4-way shadow.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "class",
+ "type" : "String",
+ "desc" : "(optional) A base CSS class to apply to the containing wrapper element (defaults to 'x-box').\nNote that there are a number of CSS rules that are dependent on this name to make the overall effect work,\nso if you supply an alternate base class, make sure you also supply all of the necessary rules.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "replace",
+ "desc" : "Replaces the passed element with this element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The element to replace",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "select",
+ "desc" : "Creates a {@link Roo.CompositeElement} for child nodes based on the passed CSS selector (the selector should not contain an id).",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "selector",
+ "type" : "String",
+ "desc" : "The CSS selector",
+ "isOptional" : false
+ },
+ {
+ "name" : "unique",
+ "type" : "Boolean",
+ "desc" : "(optional) True to create a unique Roo.Element for each child (defaults to false, which creates a single shared flyweight object)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "CompositeElement/CompositeElementLite",
+ "desc" : "The composite element"
+ }
+ ]
+ },
+ {
+ "name" : "isMasked",
+ "desc" : "Returns true if this element is masked",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getUpdateManager",
+ "desc" : "Gets this element's UpdateManager",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
+ }
+ ]
+ },
+ {
+ "name" : "insertHtml",
+ "desc" : "Inserts an html fragment into this element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "where",
+ "type" : "String",
+ "desc" : "Where to insert the html in relation to the this element - beforeBegin, afterBegin, beforeEnd, afterEnd.",
+ "isOptional" : false
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "The HTML fragment",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnEl",
+ "type" : "Boolean",
+ "desc" : "True to return an Roo.Element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement/Roo.Element",
+ "desc" : "The inserted node (or nearest related if more than 1 inserted)"
+ }
+ ]
+ },
+ {
+ "name" : "mask",
+ "desc" : "Puts a mask over this element to disable user interaction. Requires core.css.\nThis method can only be applied to elements which accept child nodes.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "(optional) A message to display in the mask",
+ "isOptional" : false
+ },
+ {
+ "name" : "msgCls",
+ "type" : "String",
+ "desc" : "(optional) A css class to apply to the msg element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Element",
+ "desc" : "The mask element"
+ }
+ ]
+ },
+ {
+ "name" : "getTop",
+ "desc" : "Gets the top Y coordinate",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "True to get the local css position instead of page coordinate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getBottom",
+ "desc" : "Gets the bottom Y coordinate of the element (element Y position + element height)",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "True to get the local css position instead of page coordinate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getRight",
+ "desc" : "Gets the right X coordinate of the element (element X position + element width)",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "True to get the local css position instead of page coordinate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "beginMeasure",
+ "desc" : "Temporarily enables offsets (width,height,x,y) for an element with display:none, use endMeasure() when done.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "appendTo",
+ "desc" : "Appends this element to the passed element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The new parent element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "fly",
+ "desc" : "Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element -\nthe dom node can be overwritten by other code.",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement",
+ "desc" : "The dom node or id",
+ "isOptional" : false
+ },
+ {
+ "name" : "named",
+ "type" : "String",
+ "desc" : "(optional) Allows for creation of named reusable flyweights to\n prevent conflicts (e.g. internally Roo uses \"_internal\")",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Element",
+ "desc" : "The shared Element object"
+ }
+ ]
+ },
+ {
+ "name" : "hasClass",
+ "desc" : "Checks if the specified CSS class exists on this element's DOM node.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "className",
+ "type" : "String",
+ "desc" : "The CSS class to check for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the class exists, else false"
+ }
+ ]
+ },
+ {
+ "name" : "findScrollableParent",
+ "desc" : "Looks at the scrollable parent element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "fitToParent",
+ "desc" : "Sizes this element to its parent element's dimensions performing\nneccessary box adjustments.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "monitorResize",
+ "type" : "Boolean",
+ "desc" : "(optional) If true maintains the fit when the browser window is resized.",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetParent",
+ "type" : "String/HTMLElment/Element",
+ "desc" : "(optional) The target parent, default to the parentNode.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "setXY",
+ "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "pos",
+ "type" : "Array",
+ "desc" : "Contains X & Y [x, y] values for new position (coordinates are page-based)",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) True for the default animation, or a standard Element animation config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "getXY",
+ "desc" : "Gets the current position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "The XY position of the element"
+ }
+ ]
+ },
+ {
+ "name" : "unselectable",
+ "desc" : "Disables text selection for this element (normalized across browsers)",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "blur",
+ "desc" : "Tries to blur the element. Any exceptions are caught and ignored.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "setRight",
+ "desc" : "Sets the element's CSS right style.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "right",
+ "type" : "String",
+ "desc" : "The right CSS property value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "findParentNode",
+ "desc" : "Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "selector",
+ "type" : "String",
+ "desc" : "The simple selector to test",
+ "isOptional" : false
+ },
+ {
+ "name" : "maxDepth",
+ "type" : "Number/String/HTMLElement/Element",
+ "desc" : "(optional) The max depth to\n search as a number or element (defaults to 10 || document.body)",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnEl",
+ "type" : "Boolean",
+ "desc" : "(optional) True to return a Roo.Element object instead of DOM node",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "The matching DOM node (or null if no match was found)"
+ }
+ ]
+ },
+ {
+ "name" : "position",
+ "desc" : "Initializes positioning on this element. If a desired position is not passed, it will make the\nthe element positioned relative IF it is not already positioned.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "pos",
+ "type" : "String",
+ "desc" : "(optional) Positioning to use \"relative\", \"absolute\" or \"fixed\"",
+ "isOptional" : false
+ },
+ {
+ "name" : "zIndex",
+ "type" : "Number",
+ "desc" : "(optional) The zIndex to apply",
+ "isOptional" : false
+ },
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "(optional) Set the page X position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "(optional) Set the page Y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "getFrameWidth",
+ "desc" : "Returns the sum width of the padding and borders for the passed \"sides\". See getBorderWidth()\n for more information about the sides.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "sides",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "setLocation",
+ "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "X value for new position (coordinates are page-based)",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "Y value for new position (coordinates are page-based)",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) True for the default animation, or a standard Element animation config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "unclip",
+ "desc" : "Return clipping (overflow) to original clipping before clip() was called",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "set",
+ "desc" : "Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function)",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The object with the attributes",
+ "isOptional" : false
+ },
+ {
+ "name" : "useSet",
+ "type" : "Boolean",
+ "desc" : "(optional) false to override the default setAttribute to use expandos.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "setDisplayed",
+ "desc" : "Sets the CSS display property. Uses originalDisplay if the specified value is a boolean true.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Boolean",
+ "desc" : "Boolean value to display the element using its default display, or a string to set the display directly",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "insertFirst",
+ "desc" : "Inserts (or creates) an element (or DomHelper config) as the first child of the this element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element/Object",
+ "desc" : "The id or element to insert or a DomHelper config to create and insert",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The new child"
+ }
+ ]
+ },
+ {
+ "name" : "animate",
+ "desc" : "Perform animation on this element.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "args",
+ "type" : "Object",
+ "desc" : "The YUI animation control args",
+ "isOptional" : false
+ },
+ {
+ "name" : "duration",
+ "type" : "Float",
+ "desc" : "(optional) How long the animation lasts in seconds (defaults to .35)",
+ "isOptional" : false
+ },
+ {
+ "name" : "onComplete",
+ "type" : "Function",
+ "desc" : "(optional) Function to call when animation completes",
+ "isOptional" : false
+ },
+ {
+ "name" : "easing",
+ "type" : "String",
+ "desc" : "(optional) Easing method to use (defaults to 'easeOut')",
+ "isOptional" : false
+ },
+ {
+ "name" : "animType",
+ "type" : "String",
+ "desc" : "(optional) 'run' is the default. Can also be 'color', 'motion', or 'scroll'",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "enableDisplayMode",
+ "desc" : "Convenience method for setVisibilityMode(Element.DISPLAY)",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "display",
+ "type" : "String",
+ "desc" : "(optional) What to set display to when visible",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "getComputedWidth",
+ "desc" : "Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders\nwhen needed to simulate offsetWidth when offsets aren't available. This may not work on display:none elements\nif a width has not been set using CSS.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "clip",
+ "desc" : "Store the current overflow setting and clip overflow on the element - use {@link #unclip} to remove",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "setVisibilityMode",
+ "desc" : "Sets the element's visibility mode. When setVisible() is called it\nwill use this to determine whether to set the visibility or the display property.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "visMode",
+ "type" : "",
+ "desc" : "Element.VISIBILITY or Element.DISPLAY",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "getColor",
+ "desc" : "Return the CSS color for the specified CSS attribute. rgb, 3 digit (like #fff) and valid values\nare convert to standard 6 digit hex color.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "attr",
+ "type" : "String",
+ "desc" : "The css attribute",
+ "isOptional" : false
+ },
+ {
+ "name" : "defaultValue",
+ "type" : "String",
+ "desc" : "The default value to use when a valid color isn't found",
+ "isOptional" : false
+ },
+ {
+ "name" : "prefix",
+ "type" : "String",
+ "desc" : "(optional) defaults to #. Use an empty string when working with\nYUI color anims.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "insertSibling",
+ "desc" : "Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element/Object",
+ "desc" : "The id or element to insert or a DomHelper config to create and insert",
+ "isOptional" : false
+ },
+ {
+ "name" : "where",
+ "type" : "String",
+ "desc" : "(optional) 'before' or 'after' defaults to before",
+ "isOptional" : false
+ },
+ {
+ "name" : "returnDom",
+ "type" : "Boolean",
+ "desc" : "(optional) True to return the raw DOM element instead of Roo.Element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "the inserted Element"
+ }
+ ]
+ },
+ {
+ "name" : "removeListener",
+ "desc" : "Removes an event handler from this element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "the type of event to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "the method the event invokes",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "applyStyles",
+ "desc" : "More flexible version of {@link #setStyle} for setting style properties.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "styles",
+ "type" : "String/Object/Function",
+ "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "getPrevSibling",
+ "desc" : "Gets the previous sibling, skipping text nodes",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "The previous sibling or null"
+ }
+ ]
+ },
+ {
+ "name" : "setBox",
+ "desc" : "Sets the element's box. Use getBox() on another element to get a box obj. If animate is true then width, height, x and y will be animated concurrently.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "box",
+ "type" : "Object",
+ "desc" : "The box to fill {x, y, width, height}",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjust",
+ "type" : "Boolean",
+ "desc" : "(optional) Whether to adjust for box-model issues automatically",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "initDDProxy",
+ "desc" : "Initializes a {@link Roo.dd.DDProxy} object for this element.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "group",
+ "type" : "String",
+ "desc" : "The group the DDProxy object is member of",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The DDProxy config object",
+ "isOptional" : false
+ },
+ {
+ "name" : "overrides",
+ "type" : "Object",
+ "desc" : "An object containing methods to override/implement on the DDProxy object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.dd.DDProxy",
+ "desc" : "The DDProxy object"
+ }
+ ]
+ },
+ {
+ "name" : "setX",
+ "desc" : "Sets the X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "The",
+ "type" : "Number",
+ "desc" : "X position of the element",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) True for the default animation, or a standard Element animation config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "setY",
+ "desc" : "Sets the Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "The",
+ "type" : "Number",
+ "desc" : "Y position of the element",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) True for the default animation, or a standard Element animation config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "query",
+ "desc" : "Selects child nodes based on the passed CSS selector (the selector should not contain an id).",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "selector",
+ "type" : "String",
+ "desc" : "The CSS selector",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "An array of the matched nodes"
+ }
+ ]
+ },
+ {
+ "name" : "getAnchorXY",
+ "desc" : "Gets the x,y coordinates specified by the anchor position on the element.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "anchor",
+ "type" : "String",
+ "desc" : "(optional) The specified anchor position (defaults to \"c\"). See {@link #alignTo} for details on supported anchor positions.",
+ "isOptional" : false
+ },
+ {
+ "name" : "size",
+ "type" : "Object",
+ "desc" : "(optional) An object containing the size to use for calculating anchor position\n {width: (target width), height: (target height)} (defaults to the element's current size)",
+ "isOptional" : false
+ },
+ {
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) True to get the local (element top/left-relative) anchor position instead of page coordinates",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "[x, y] An array containing the element's x and y coordinates"
+ }
+ ]
+ },
+ {
+ "name" : "initDD",
+ "desc" : "Initializes a {@link Roo.dd.DD} drag drop object for this element.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "group",
+ "type" : "String",
+ "desc" : "The group the DD object is member of",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The DD config object",
+ "isOptional" : false
+ },
+ {
+ "name" : "overrides",
+ "type" : "Object",
+ "desc" : "An object containing methods to override/implement on the DD object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.dd.DD",
+ "desc" : "The DD object"
+ }
+ ]
+ },
+ {
+ "name" : "getComputedHeight",
+ "desc" : "Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders\nwhen needed to simulate offsetHeight when offsets aren't available. This may not work on display:none elements\nif a height has not been set using CSS.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "is",
+ "desc" : "Returns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child)",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "selector",
+ "type" : "String",
+ "desc" : "The simple selector to test",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if this element matches the selector, else false"
+ }
+ ]
+ },
+ {
+ "name" : "move",
+ "desc" : "Move this element relative to its current position.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "direction",
+ "type" : "String",
+ "desc" : "Possible values are: \"l\",\"left\" - \"r\",\"right\" - \"t\",\"top\",\"up\" - \"b\",\"bottom\",\"down\".",
+ "isOptional" : false
+ },
+ {
+ "name" : "distance",
+ "type" : "Number",
+ "desc" : "How far to move the element in pixels",
+ "isOptional" : false
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean/Object",
+ "desc" : "(optional) true for the default animation or a standard Element animation config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "remove",
+ "desc" : "Removes this element from the DOM and deletes it from the cache",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "getNextSibling",
+ "desc" : "Gets the next sibling, skipping text nodes",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "The next sibling or null"
+ }
+ ]
+ },
+ {
+ "name" : "getStyle",
+ "desc" : "Normalizes currentStyle and computedStyle. This is not YUI getStyle, it is an optimised version.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "property",
+ "type" : "String",
+ "desc" : "The style property whose value is returned.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "The current value of the style property for this element."
+ }
+ ]
+ },
+ {
+ "name" : "isBorderBox",
+ "desc" : "Tests various css rules/browsers to determine if this element uses a border box",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getPadding",
+ "desc" : "Gets the width of the padding(s) for the specified side(s)",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Element",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "side",
+ "type" : "String",
+ "desc" : "Can be t, l, r, b or any combination of those to add multiple values. For example,\npassing lr would get the padding (l)eft + the padding (r)ight.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The padding of the sides passed added together"
+ }
+ ]
+ }
+ ],
+ "events" : [
+ ]
+}
\ No newline at end of file