X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..3789b528d8dd8aad4558e38e22d775bcab1cbd36:/docs/output/Ext.util.Floating.js diff --git a/docs/output/Ext.util.Floating.js b/docs/output/Ext.util.Floating.js new file mode 100644 index 00000000..9fc6cdff --- /dev/null +++ b/docs/output/Ext.util.Floating.js @@ -0,0 +1,234 @@ +Ext.data.JsonP.Ext_util_Floating({ + "tagname": "class", + "name": "Ext.util.Floating", + "doc": "

A mixin to add floating capability to a Component

\n", + "extends": null, + "mixins": [ + + ], + "alternateClassNames": [ + + ], + "xtype": null, + "author": null, + "docauthor": null, + "singleton": false, + "private": false, + "cfg": [ + { + "tagname": "cfg", + "name": "focusOnToFront", + "member": "Ext.util.Floating", + "type": "Boolean", + "doc": "

Specifies whether the floated component should be automatically focused when it is\nbrought to the front. Defaults to true.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", + "linenr": 9, + "html_filename": "Floating.html", + "href": "Floating.html#Ext-util-Floating-cfg-focusOnToFront", + "shortDoc": "Specifies whether the floated component should be automatically focused when it is\nbrought to the front. Defaults to ..." + }, + { + "tagname": "cfg", + "name": "shadow", + "member": "Ext.util.Floating", + "type": "String/Boolean", + "doc": "

Specifies whether the floating component should be given a shadow. Set to\ntrue to automatically create an Ext.Shadow, or a string indicating the\nshadow's display Ext.Shadow.mode. Set to false to disable the shadow.\n(Defaults to 'sides'.)

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", + "linenr": 16, + "html_filename": "Floating.html", + "href": "Floating.html#Ext-util-Floating-cfg-shadow", + "shortDoc": "Specifies whether the floating component should be given a shadow. Set to\ntrue to automatically create an Ext.Shadow,..." + } + ], + "method": [ + { + "tagname": "method", + "name": "alignTo", + "member": "Ext.util.Floating", + "doc": "

Aligns this floating Component to the specified element

\n", + "params": [ + { + "type": "Mixed", + "name": "element", + "doc": "

The element or Ext.Component to align to. If passing a component, it must\nbe a omponent instance. If a string id is passed, it will be used as an element id.

\n", + "optional": false + }, + { + "type": "String", + "name": "position", + "doc": "

(optional, defaults to \"tl-bl?\") The position to align to (see Ext.core.Element.alignTo for more details).

\n", + "optional": false + }, + { + "type": "Array", + "name": "offsets", + "doc": "

(optional) Offset the positioning by [x, y]

\n", + "optional": true + } + ], + "return": { + "type": "Component", + "doc": "

this

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", + "linenr": 171, + "html_filename": "Floating.html", + "href": "Floating.html#Ext-util-Floating-method-alignTo", + "shortDoc": "

Aligns this floating Component to the specified element

\n" + }, + { + "tagname": "method", + "name": "center", + "member": "Ext.util.Floating", + "doc": "

Center this Component in its container.

\n", + "params": [ + + ], + "return": { + "type": "Component", + "doc": "

this

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", + "linenr": 249, + "html_filename": "Floating.html", + "href": "Floating.html#Ext-util-Floating-method-center", + "shortDoc": "

Center this Component in its container.

\n" + }, + { + "tagname": "method", + "name": "doConstrain", + "member": "Ext.util.Floating", + "doc": "

Moves this floating Component into a constrain region.

\n\n\n

By default, this Component is constrained to be within the container it was added to, or the element\nit was rendered to.

\n\n\n

An alternative constraint may be passed.

\n\n", + "params": [ + { + "type": "Mixed", + "name": "constrainTo", + "doc": "

Optional. The Element or Region into which this Component is to be constrained.

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", + "linenr": 133, + "html_filename": "Floating.html", + "href": "Floating.html#Ext-util-Floating-method-doConstrain", + "shortDoc": "Moves this floating Component into a constrain region.\n\n\nBy default, this Component is constrained to be within the c..." + }, + { + "tagname": "method", + "name": "setActive", + "member": "Ext.util.Floating", + "doc": "

This method is called internally by Ext.ZIndexManager to signal that a floating\nComponent has either been moved to the top of its zIndex stack, or pushed from the top of its zIndex stack.

\n\n\n

If a Window is superceded by another Window, deactivating it hides its shadow.

\n\n\n

This method also fires the activate or deactivate event depending on which action occurred.

\n\n", + "params": [ + { + "type": "Boolean", + "name": "active", + "doc": "

True to activate the Component, false to deactivate it (defaults to false)

\n", + "optional": false + }, + { + "type": "Component", + "name": "newActive", + "doc": "

The newly active Component which is taking over topmost zIndex position.

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", + "linenr": 216, + "html_filename": "Floating.html", + "href": "Floating.html#Ext-util-Floating-method-setActive", + "shortDoc": "This method is called internally by Ext.ZIndexManager to signal that a floating\nComponent has either been moved to th..." + }, + { + "tagname": "method", + "name": "toBack", + "member": "Ext.util.Floating", + "doc": "

Sends this Component to the back of (lower z-index than) any other visible windows

\n", + "params": [ + + ], + "return": { + "type": "Component", + "doc": "

this

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", + "linenr": 240, + "html_filename": "Floating.html", + "href": "Floating.html#Ext-util-Floating-method-toBack", + "shortDoc": "

Sends this Component to the back of (lower z-index than) any other visible windows

\n" + }, + { + "tagname": "method", + "name": "toFront", + "member": "Ext.util.Floating", + "doc": "

Brings this floating Component to the front of any other visible, floating Components managed by the same ZIndexManager

\n\n\n

If this Component is modal, inserts the modal mask just below this Component in the z-index stack.

\n\n", + "params": [ + { + "type": "Boolean", + "name": "preventFocus", + "doc": "

(optional) Specify true to prevent the Component from being focused.

\n", + "optional": true + } + ], + "return": { + "type": "Component", + "doc": "

this

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", + "linenr": 188, + "html_filename": "Floating.html", + "href": "Floating.html#Ext-util-Floating-method-toFront", + "shortDoc": "Brings this floating Component to the front of any other visible, floating Components managed by the same ZIndexManag..." + } + ], + "property": [ + + ], + "event": [ + + ], + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", + "linenr": 1, + "html_filename": "Floating.html", + "href": "Floating.html#Ext-util-Floating", + "cssVar": [ + + ], + "cssMixin": [ + + ], + "component": false, + "superclasses": [ + + ], + "subclasses": [ + + ], + "mixedInto": [ + "Ext.Component" + ], + "allMixins": [ + + ] +}); \ No newline at end of file