X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/25ef3491bd9ae007ff1fc2b0d7943e6eaaccf775..10a866c12701c0a0afd0ac85dcdcf32a421514ac:/docs/output/Ext.Layer.html diff --git a/docs/output/Ext.Layer.html b/docs/output/Ext.Layer.html index c71ef4d6..d22b3a41 100644 --- a/docs/output/Ext.Layer.html +++ b/docs/output/Ext.Layer.html @@ -1,4 +1,4 @@ -
Element Layer
Package: | Ext |
Defined In: | Layer.js |
Class: | Layer |
Extends: | Element |
Element Layer
Package: | Ext |
Defined In: | Layer.js |
Class: | Layer |
Extends: | Element |
Config Options | Defined By | ||
---|---|---|---|
cls : String CSS class to add to the element | Layer | ||
constrain : Boolean False to disable constrain to viewport (defaults to true) | Layer | ||
dh : Object DomHelper object config to create element with (defaults to {tag: 'div', cls: 'x-layer'}). | Layer | ||
shadow : String/Boolean True to automatically create an Ext.Shadow, or a string indicating the
shadow's display Ext.Shadow.mode. False to dis... True to automatically create an Ext.Shadow, or a string indicating the
shadow's display Ext.Shadow.mode. False to disable the shadow. (defaults to false) | Layer | ||
shadowOffset : Number Number of pixels to offset the shadow (defaults to 4) | Layer | ||
shim : Boolean False to disable the iframe shim in browsers which need one (defaults to true) | Layer | ||
useDisplay : Boolean Defaults to use css offsets to hide the Layer. Specify true
@@ -14,149 +14,149 @@ to use css style 'display:none;' to hide the Layer. | Sets up event handlers to add and remove a css class when the mouse is over this element Sets up event handlers to add and remove a css class when the mouse is over this element Parameters:
| Element | |
addKeyListener( Number/Array/Object/String key , Function fn , [Object scope ] )
:
Ext.KeyMapConvenience method for constructing a KeyMap Convenience method for constructing a KeyMap Parameters:
| Element | ||
addKeyMap( Object config )
+{key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)} fn : FunctionThe function to call scope : Object(optional) The scope ( this reference) in which the specified function is executed. Defaults to this Element.
| Element | ||
addKeyMap( Object config )
:
Ext.KeyMapCreates a KeyMap for this element Creates a KeyMap for this element Parameters:
| Element | ||
addListener( String eventName , Function fn , [Object scope ], [Object options ] )
:
- Ext.ElementAppends an event handler to this element. The shorthand version on is equivalent. Appends an event handler to this element. The shorthand version on is equivalent. Parameters:
| Element | ||
alignTo( Mixed element , String position , [Array offsets ], [Boolean/Object animate ] )
:
- Ext.ElementAligns this element with another element relative to the specified anchor points. If the other element is the
-docume... Aligns this element with another element relative to the specified anchor points. If the other element is the
-document it aligns it to the viewport.
-The position parameter is optional, and can be specified in any one of the following formats:
-
-Value Description ------ ----------------------------- -tl The top left corner (default) -t The center of the top edge -tr The top right corner -l The center of the left edge -c In the center of the element -r The center of the right edge -bl The bottom left corner -b The center of the bottom edge -br The bottom right corner --Example Usage: -
Parameters:
| Element | ||
anchorTo( Mixed element , String position , [Array offsets ], [Boolean/Object animate ], [Boolean/Number monitorScroll ], Function callback )
+ Ext.ElementAligns this element with another element relative to the specified anchor points. If the other element is the
+documen... Aligns this element with another element relative to the specified anchor points. If the other element is the
+document it aligns it to the viewport.
+The position parameter is optional, and can be specified in any one of the following formats:
+
+Value Description +----- ----------------------------- +tl The top left corner (default) +t The center of the top edge +tr The top right corner +l The center of the left edge +c In the center of the element +r The center of the right edge +bl The bottom left corner +b The center of the bottom edge +br The bottom right corner ++Example Usage: +
Parameters:
| Element | ||
anchorTo( Mixed element , String position , [Array offsets ], [Boolean/Object animate ], [Boolean/Number monitorScroll ], Function callback )
:
- Ext.ElementAnchors an element to another element and realigns it when the window is resized. Anchors an element to another element and realigns it when the window is resized. Parameters:
| Element | ||
animate( Object args , [Float duration ], [Function onComplete ], [String easing ], [String animType ] )
:
Ext.ElementPerform custom animation on this element.
@@ -285,23 +285,23 @@ is of this form:
<div class="{0}-bl"><div class="{0}-br"><div class="{0}-bc"></div></div></div>';
Example usage:
Parameters:
| Element | ||
center( [Mixed centerIn ] )
+also supply all of the necessary rules.Returns:
| Element | ||
center( [Mixed centerIn ] )
:
voidCenters the Element in either the viewport, or another Element. Centers the Element in either the viewport, or another Element. Parameters:
| Element | ||
child( String selector , [Boolean returnDom ] )
:
HTMLElement/Ext.ElementSelects a single child at any depth below this element based on the passed CSS selector (the selector should not cont... Selects a single child at any depth below this element based on the passed CSS selector (the selector should not contain an id). Parameters:
| Element | ||
clean( [Boolean forceReclean ] )
:
- voidRemoves worthless text nodes Removes worthless text nodes Parameters:
| Element | ||
clearOpacity()
:
Ext.Element Clears any opacity settings from this element. Required in some cases for IE. Clears any opacity settings from this element. Required in some cases for IE. Parameters:
| Element | ||
clearPositioning( [String value ] )
@@ -332,22 +332,22 @@ showing through.Parameters:
| Element | ||
fly( String/HTMLElement el , [String named ] )
:
- ElementGets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to t... Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element - -the dom node can be overwritten by other code. Shorthand of Ext.Element.fly -Use this to make one-time references to DOM elements which are not going to be accessed again either by -application code, or by Ext's classes. If accessing an element which will be processed regularly, then Ext.get -will be more appropriate to take advantage of the caching provided by the Ext.Element class. Parameters:
| Element | ||
focus( [Number defer ] )
:
Ext.ElementTries to focus the element. Any exceptions are caught and ignored. Tries to focus the element. Any exceptions are caught and ignored. Parameters:
| Element | ||
getAlignToXY( Mixed element , String position , [Array offsets ] )
:
- ArrayGets the x,y coordinates to align this element with another element. See alignTo for more info on the
-supported posi... Gets the x,y coordinates to align this element with another element. See alignTo for more info on the
-supported position values. Parameters:
| Element | ||
getAnchorXY( [String anchor ], [Boolean local ], [Object size ] )
+ ArrayGets the x,y coordinates to align this element with another element. See alignTo for more info on the
+supported posit... Gets the x,y coordinates to align this element with another element. See alignTo for more info on the
+supported position values. Parameters:
| Element | ||
getAnchorXY( [String anchor ], [Boolean local ], [Object size ] )
:
- ArrayGets the x,y coordinates specified by the anchor position on the element. Gets the x,y coordinates specified by the anchor position on the element. Parameters:
| Element | ||
getAttribute( String name , [String namespace ] )
:
StringReturns the value of an attribute from the element's underlying DOM node. Returns the value of an attribute from the element's underlying DOM node. Parameters:
| Element | ||
getAttributeNS( String namespace , String name )
@@ -359,9 +359,20 @@ passing 'lr' would get the border left width + the border
:
NumberGets the bottom Y coordinate of the element (element Y position + element height) Gets the bottom Y coordinate of the element (element Y position + element height) Parameters:
| Element | ||
getBox( [Boolean contentBox ], [Boolean local ] )
:
- ObjectReturn a box {x, y, width, height} that can be used to set another elements
-size/location to match this element. Return a box {x, y, width, height} that can be used to set another elements
-size/location to match this element. Parameters:
| Element | ||
getCenterXY()
+ Object Return an object defining the area of this Element which can be passed to setBox to
+set another Element's size/locat... Return an object defining the area of this Element which can be passed to setBox to
+set another Element's size/location to match this element. Parameters:
| Element | ||
getCenterXY()
:
Array Calculates the x, y to center this element on the screen Calculates the x, y to center this element on the screen Parameters:
| Element | ||
getColor( String attr , String defaultValue , [String prefix ] )
:
@@ -381,8 +392,8 @@ when needed to simulate offsetWidth when offsets aren't available. This may not
if a width has not been set using CSS.Parameters:
| Element | ||
getFrameWidth( String sides )
:
NumberReturns the sum width of the padding and borders for the passed "sides". See getBorderWidth()
- for more informa... Returns the sum width of the padding and borders for the passed "sides". See getBorderWidth()
- for more information about the sides. Parameters:
| Element | ||
getHeight( [Boolean contentHeight ] )
+ for more info...Returns the sum width of the padding and borders for the passed "sides". See getBorderWidth()
+ for more information about the sides. Parameters:
| Element | ||
getHeight( [Boolean contentHeight ] )
:
NumberReturns the offset height of the element Returns the offset height of the element Parameters:
| Element | ||
getLeft( Boolean local )
:
@@ -423,20 +434,20 @@ For example, el.getStyles('color', 'font-size', 'width') might return
:
Ext.UpdaterGets this element's Updater Gets this element's Updater Parameters:
| Element | ||
getValue( Boolean asNumber )
:
- String/NumberReturns the value of the "value" attribute Returns the value of the "value" attribute Parameters:
| Element | ||
getViewSize()
+ String/Number Returns the value of the "value" attribute Returns the value of the "value" attribute Parameters:
| Element | ||
getViewSize( Boolean contentBox )
:
- ObjectReturns the width and height of the viewport.
-var vpSize = Ext.getBody().getViewSize();
-
- // all Windows cr... Returns the width and height of the viewport.
-
| Element | ||
getWidth( [Boolean contentWidth ] )
+ // To handle window resizing you would have to hook onto onWindowResize.Parameters:
| Element | ||
getWidth( [Boolean contentWidth ] )
:
NumberReturns the offset width of the element Returns the offset width of the element Parameters:
| Element | ||
getX()
:
@@ -471,7 +482,7 @@ Ext.Error class. Parameters:
| Element | ||
insertSibling( Mixed/Object/Array el , [String where ], [Boolean returnDom ] )
:
- Ext.ElementInserts (or creates) the passed element (or DomHelper config) as a sibling of this element Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element Parameters:
| Element | ||
is( String selector )
+ Ext.ElementInserts (or creates) the passed element (or DomHelper config) as a sibling of this element Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element Parameters:
| Element | ||
is( String selector )
:
BooleanReturns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child) Returns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child) Parameters:
| Element | ||
isBorderBox()
:
@@ -487,8 +498,8 @@ Ext.Error class. Parameters:
| Element | ||
load()
:
- Ext.Element Direct access to the Updater Ext.Updater.update method. The method takes the same object
-parameter as Ext.Updater.up... Direct access to the Updater Ext.Updater.update method. The method takes the same object
+ Ext.Element Direct access to the Updater Ext.Updater.update method. The method takes the same object
+parameter as Ext.Updater.upd... Direct access to the Updater Ext.Updater.update method. The method takes the same object
parameter as Ext.Updater.update Parameters:
| Element | ||
mask( [String msg ], [String msgCls ] )
:
ElementPuts a mask over this element to disable user interaction. Requires core.css.
@@ -511,31 +522,35 @@ The element must be part of the DOM tree to have page coordinates (display:none
the element positione... Initializes positioning on this element. If a desired position is not passed, it will make the
the element positioned relative IF it is not already positioned. Parameters:
| Element | ||
prev( [String selector ], [Boolean returnDom ] )
:
- Ext.Element/HTMLElementGets the previous sibling, skipping text nodes Gets the previous sibling, skipping text nodes Parameters:
| Element | ||
query( String selector )
+ Ext.Element/HTMLElementGets the previous sibling, skipping text nodes Gets the previous sibling, skipping text nodes Parameters:
| Element | ||
purgeAllListeners()
+ :
+ Ext.Element Recursively removes all previous added listeners from this element and its children Recursively removes all previous added listeners from this element and its children Parameters:
| Element | ||
query( String selector )
:
ArraySelects child nodes based on the passed CSS selector (the selector should not contain an id). Selects child nodes based on the passed CSS selector (the selector should not contain an id). Parameters:
| Element | ||
radioClass( String/Array className )
:
Ext.ElementAdds one or more CSS classes to this element and removes the same class(es) from all siblings. Adds one or more CSS classes to this element and removes the same class(es) from all siblings. Parameters:
| Element | ||
relayEvent( String eventName , Object object )
:
- voidCreate an event handler on this element such that when the event fires and is handled by this element,
-it will be re... Create an event handler on this element such that when the event fires and is handled by this element,
-it will be relayed to another object (i.e., fired again as if it originated from that object instead). Parameters:
| Element | ||
remove()
:
- void Removes this element from the DOM and deletes it from the cache Removes this element from the DOM and deletes it from the cache Parameters:
| Element | ||
removeAllListeners()
+ void Removes this element's dom reference. Note that event and cache removal is handled at Ext.removeNode Removes this element's dom reference. Note that event and cache removal is handled at Ext.removeNode Parameters:
| Element | ||
removeAllListeners()
+ :
+ Ext.Element Removes all previous added listeners from this element Removes all previous added listeners from this element Parameters:
| Element | ||
removeAnchor()
:
- Ext.Element Removes all previous added listeners from this element Removes all previous added listeners from this element Parameters:
| Element | ||
removeClass( String/Array className )
+ Ext.ElementRemove any anchor to this element. See anchorTo. Remove any anchor to this element. See anchorTo. Parameters:
| Element | ||
removeClass( String/Array className )
:
Ext.ElementRemoves one or more CSS classes from the element. Removes one or more CSS classes from the element. Parameters:
| Element | ||
removeListener( String eventName , Function fn , Object scope )
:
- Ext.ElementRemoves an event handler from this element. The shorthand version un is equivalent.
-Note: if a scope was explicitly... Removes an event handler from this element. The shorthand version un is equivalent.
-Note: if a scope was explicitly specified when adding the
-listener, the same scope must be specified here.
-Example:
-
Parameters:
| Element | ||
repaint()
:
Ext.Element Forces the browser to repaint this element Forces the browser to repaint this element Parameters:
| Element | ||
replace( Mixed el )
@@ -554,7 +569,7 @@ was scrolled as far as it could go. | Scrolls this element into view within the passed container. Scrolls this element into view within the passed container. Parameters:
| Element | |
scrollTo( String side , Number value , [Boolean/Object animate ] )
:
- ElementScrolls this element the specified scroll point. It does NOT do bounds checking so if you scroll to a weird value it ... Scrolls this element the specified scroll point. It does NOT do bounds checking so if you scroll to a weird value it will try to do it. For auto bounds checking, use scroll(). Parameters:
| Element | ||
select( String selector , [Boolean unique ] )
+ ElementScrolls this element the specified scroll point. It does NOT do bounds checking so if you scroll to a weird value it ... Scrolls this element the specified scroll point. It does NOT do bounds checking so if you scroll to a weird value it will try to do it. For auto bounds checking, use scroll(). Parameters:
| Element | ||
select( String selector , [Boolean unique ] )
:
CompositeElement/CompositeElementLiteCreates a Ext.CompositeElement for child nodes based on the passed CSS selector (the selector should not contain an i... Creates a Ext.CompositeElement for child nodes based on the passed CSS selector (the selector should not contain an id). Parameters:
| Element | ||
set( Object o , [Boolean useSet ] )
:
@@ -584,7 +599,7 @@ Ext.fly('elementId').setHeight(200, true);
Ext.fly('elId').setHeight(150, {
duration : .5, // animation will have a duration of .5 seconds
// will change the content to "finished"
- callback: function(){ this.update("finished"); }
+ callback: function(){ this.update("finished"); }
});Parameters:
| Element | ||
un( String eventName , Function fn , Object scope )
:
- Ext.ElementRemoves an event handler from this element (see removeListener for additional notes). Removes an event handler from this element (see removeListener for additional notes). Parameters:
| Element | ||
unclip()
:
Ext.Element Return clipping (overflow) to original clipping before clip was called Return clipping (overflow) to original clipping before clip was called Parameters:
| Element | ||
unmask() |