+++ /dev/null
-{
- "name" : "Roo.LayoutManager",
- "augments" : [
- "Roo.util.Observable"
- ],
- "desc" : "Base class for layout managers.",
- "isSingleton" : false,
- "isStatic" : false,
- "isBuiltin" : false,
- "memberOf" : "LayoutManager",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- ],
- "returns" : [
- ],
- "config" : [
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable",
- "values" : [
- ]
- }
- ],
- "methods" : [
- {
- "name" : "getRegion",
- "desc" : "Returns the specified region.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.LayoutManager",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "target",
- "type" : "String",
- "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.LayoutRegion",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "beginUpdate",
- "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.LayoutManager",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- ],
- "returns" : [
- ]
- },
- {
- "name" : "isUpdating",
- "desc" : "Returns true if this layout is currently being updated",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.LayoutManager",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getViewSize",
- "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.LayoutManager",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "The size as an object {width: (the width), height: (the height)}"
- }
- ]
- },
- {
- "name" : "endUpdate",
- "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.LayoutManager",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "noLayout",
- "type" : "Boolean",
- "desc" : "true to disable a layout update",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "getEl",
- "desc" : "Returns the Element this layout is bound to.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.LayoutManager",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "purgeListeners",
- "desc" : "Removes all listeners for this object",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- ],
- "returns" : [
- ]
- },
- {
- "name" : "on",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "un",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "addEvents",
- "desc" : "Used to define events on this Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "releaseCapture",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "removeListener",
- "desc" : "Removes a listener",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "fireEvent",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
- },
- {
- "name" : "hasListener",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
- },
- {
- "name" : "capture",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "addListener",
- "desc" : "Appends an event handler to this component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- }
- ],
- "events" : [
- {
- "name" : "layout",
- "desc" : "Fires when a layout is performed.",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.LayoutManager",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "regionexpanded",
- "desc" : "Fires when a region is expanded.",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The expanded region",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "regionresized",
- "desc" : "Fires when the user resizes a region.",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The resized region",
- "isOptional" : false
- },
- {
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new size (width for east/west, height for north/south)",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- },
- {
- "name" : "regioncollapsed",
- "desc" : "Fires when a region is collapsed.",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The collapsed region",
- "isOptional" : false
- }
- ],
- "returns" : [
- ]
- }
- ]
-}
\ No newline at end of file
projects / roojs1 / blobdiff