Class Roo.Layer

Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out.

Parameters:

String/Array className

The CSS class to add, or an array of classes

Returns:

Roo.Element this

Sets up event handlers to add and remove a css class when the mouse is down and then up on this element (a click effect)

Parameters:

String className

Returns:

Roo.Element this

Sets up event handlers to add and remove a css class when this element has the focus

Parameters:

String className

Returns:

Roo.Element this

Sets up event handlers to add and remove a css class when the mouse is over this element

Parameters:

String className

Boolean preventFlicker

(optional) If set to true, it prevents flickering by filtering
mouseout events for children elements

Returns:

Roo.Element this

Convenience method for constructing a KeyMap

Parameters:

Number/Array/Object/String key

Either a string with the keys to listen for, the numeric key code, array of key codes or an object with the following options:
{key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}

Function fn

The function to call

Object scope

(optional) The scope of the function

Returns:

Roo.KeyMap The KeyMap created

Creates a KeyMap for this element

Parameters:

Object config

The KeyMap config. See {link Roo.KeyMap} for more details

Returns:

Roo.KeyMap The KeyMap created

Appends an event handler

Parameters:

String eventName

The type of event to append

Function fn

The method the event invokes

Object scope

(optional) The scope (this object) of the fn

Object options

(optional)An object with standard {link Roo.EventManageraddListener} options

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:

• Blank: Defaults to aligning the element's top-left corner to the target's bottom-left corner ("tl-bl").


• One anchor (deprecated): The passed anchor position is used as the target element's anchor point.
  The element being aligned will position its top-left corner (tl) to that point. This method has been
  deprecated in favor of the newer two anchor syntax below.


• Two anchors: If two values from the table below are passed separated by a dash, the first value is used as the
  element's anchor point, and the second value is used as the target's anchor point.

In addition to the anchor points, the position parameter also supports the "?" character. If "?" is passed at the end of
the position string, the element will attempt to align as specified, but the position will be adjusted to constrain to
the viewport if necessary. Note that the element being aligned might be swapped to align to a different position than
that specified in order to enforce the viewport constraints.
Following are all of the supported anchor positions:

    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:

    // align el to other-el using the default positioning ("tl-bl", non-constrained)
    el.alignTo("other-el");

    // align the top left corner of el with the top right corner of other-el (constrained to viewport)
    el.alignTo("other-el", "tr?");

    // align the bottom right corner of el with the center left edge of other-el
    el.alignTo("other-el", "br-l?");

    // align the center of el with the bottom left corner of other-el and
    // adjust the x position by -6 pixels (and the y position by 0)
    el.alignTo("other-el", "c-bl", [-6, 0]);
    

Parameters:

String/HTMLElement/Roo.Element element

The element to align to.

String position

The position to align to.

Array offsets

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

Boolean/Object animate

(optional) true for the default animation or a standard Element animation config object

Returns:

Roo.Element this

Anchors an element to another element and realigns it when the window is resized.

Parameters:

String/HTMLElement/Roo.Element element

The element to align to.

String position

The position to align to.

Array offsets

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

Boolean/Object animate

(optional) True for the default animation or a standard Element animation config object

Boolean/Number monitorScroll

(optional) True to monitor body scroll and reposition. If this parameter
is a number, it is used as the buffer delay (defaults to 50ms).

Function callback

The function to call after the animation finishes

Returns:

Roo.Element this

Perform animation on this element.

Parameters:

Object args

The YUI animation control args

Float duration

(optional) How long the animation lasts in seconds (defaults to .35)

Function onComplete

(optional) Function to call when animation completes

String easing

(optional) Easing method to use (defaults to 'easeOut')

String animType

(optional) 'run' is the default. Can also be 'color', 'motion', or 'scroll'

Returns:

Roo.Element this

Appends the passed element(s) to this element

Parameters:

String/HTMLElement/Array/Element/CompositeElement el

Returns:

Roo.Element this

Appends this element to the passed element

Parameters:

String/HTMLElement/Element el

The new parent element

Returns:

Roo.Element this

More flexible version of {link setStyle} for setting style properties.

Parameters:

String/Object/Function styles

A style specification string, e.g. "width:100px", or object in the form {width:"100px"}, or
a function which returns such a specification.

Returns:

Roo.Element this

Sets or Returns the value the dom attribute value

Parameters:

String|Object name

The attribute name (or object to set multiple attributes)

String value

(optional) The value to set the attribute to

Returns:

String The attribute value

Measures the element's content height and updates height to match. Note: this function uses setTimeout so
the new height may not be available immediately.

Parameters:

Boolean animate

(optional) Animate the transition (defaults to false)

Float duration

(optional) Length of the animation in seconds (defaults to .35)

Function onComplete

(optional) Function to call when animation completes

String easing

(optional) Easing method to use (defaults to easeOut)

Returns:

Roo.Element this

Temporarily enables offsets (width,height,x,y) for an element with display:none, use endMeasure() when done.

Returns:

Roo.Element this

Tries to blur the element. Any exceptions are caught and ignored.

Returns:

Roo.Element this

Wraps the specified element with a special markup/CSS block that renders by default as a gray container with a
gradient background, rounded corners and a 4-way shadow.

Parameters:

String class

(optional) A base CSS class to apply to the containing wrapper element (defaults to 'x-box').
Note that there are a number of CSS rules that are dependent on this name to make the overall effect work,
so if you supply an alternate base class, make sure you also supply all of the necessary rules.

Returns:

Roo.Element this

Centers the Element in either the viewport, or another Element.

Parameters:

String/HTMLElement/Roo.Element centerIn

(optional) The element in which to center the element.

Selects a single child at any depth below this element based on the passed CSS selector (the selector should not contain an id).

Parameters:

String selector

The CSS selector

Boolean returnDom

(optional) True to return the DOM node instead of Roo.Element (defaults to false)

Returns:

HTMLElement/Roo.Element The child Roo.Element (or DOM node if returnDom = true)

Removes worthless text nodes

Parameters:

Boolean forceReclean

(optional) By default the element
keeps track if it has been cleaned already so
you can call this over and over. However, if you update the element and
need to force a reclean, you can pass true.

Clears any opacity settings from this element. Required in some cases for IE.

Returns:

Roo.Element this

Clear positioning back to the default when the document was loaded

Parameters:

String value

(optional) The value to use for the left,right,top,bottom, defaults to '' (empty string). You could use 'auto'.

Returns:

Roo.Element this

Store the current overflow setting and clip overflow on the element - use {link unclip} to remove

Returns:

Roo.Element this

Returns true if this element is an ancestor of the passed element

Parameters:

HTMLElement/String el

The element to check

Returns:

Boolean True if this element is an ancestor of el, else false

Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element.

Parameters:

Object config

DomHelper element config object. If no tag is specified (e.g., {tag:'input'}) then a div will be
automatically generated with the specified attributes.

HTMLElement insertBefore

(optional) a child element of this element

Boolean returnDom

(optional) true to return the dom node instead of creating an Element

Returns:

Roo.Element The new child element

Creates a proxy element of this element

Parameters:

String/Object config

The class name of the proxy element or a DomHelper config object

String/HTMLElement renderTo

(optional) The element or element id to render the proxy to (defaults to document.body)

Boolean matchBox

(optional) True to align and size the proxy to this element now (defaults to false)

Returns:

Roo.Element The new proxy element

Creates an iframe shim for this element to keep selects and other windowed objects from
showing through.

Returns:

Roo.Element The new shim element

Selects a single *direct* child based on the passed CSS selector (the selector should not contain an id).

Parameters:

String selector

The CSS selector

Boolean returnDom

(optional) True to return the DOM node instead of Roo.Element (defaults to false)

Returns:

HTMLElement/Roo.Element The child Roo.Element (or DOM node if returnDom = true)

Convenience method for setVisibilityMode(Element.DISPLAY)

Parameters:

String display

(optional) What to set display to when visible

Returns:

Roo.Element this

Restores displays to before beginMeasure was called

Returns:

Roo.Element this

Looks at this node and then at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)

Parameters:

String selector

The simple selector to test

Number/String/HTMLElement/Element maxDepth

(optional) The max depth to
search as a number or element (defaults to 10 || document.body)

Boolean returnEl

(optional) True to return a Roo.Element object instead of DOM node

Returns:

HTMLElement The matching DOM node (or null if no match was found)

Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)

Parameters:

String selector

The simple selector to test

Number/String/HTMLElement/Element maxDepth

(optional) The max depth to
search as a number or element (defaults to 10 || document.body)

Boolean returnEl

(optional) True to return a Roo.Element object instead of DOM node

Returns:

HTMLElement The matching DOM node (or null if no match was found)

Looks at the scrollable parent element

Sizes this element to its parent element's dimensions performing
neccessary box adjustments.

Parameters:

Boolean monitorResize

(optional) If true maintains the fit when the browser window is resized.

String/HTMLElment/Element targetParent

(optional) The target parent, default to the parentNode.

Returns:

Roo.Element this

Tries to focus the element. Any exceptions are caught and ignored.

Returns:

Roo.Element this

Gets the x,y coordinates to align this element with another element. See {link alignTo} for more info on the
supported position values.

Parameters:

String/HTMLElement/Roo.Element element

The element to align to.

String position

The position to align to.

Array offsets

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

Returns:

Array [x, y]

Gets the x,y coordinates specified by the anchor position on the element.

Parameters:

String anchor

(optional) The specified anchor position (defaults to "c"). See {link alignTo} for details on supported anchor positions.

Object size

(optional) An object containing the size to use for calculating anchor position
{width: (target width), height: (target height)} (defaults to the element's current size)

Boolean local

(optional) True to get the local (element top/left-relative) anchor position instead of page coordinates

Returns:

Array [x, y] An array containing the element's x and y coordinates

Returns the value of a namespaced attribute from the element's underlying DOM node.

Parameters:

String namespace

The namespace in which to look for the attribute

String name

The attribute name

Returns:

String The attribute value

Gets the width of the border(s) for the specified side(s)

Parameters:

String side

Can be t, l, r, b or any combination of those to add multiple values. For example,
passing lr would get the border (l)eft width + the border (r)ight width.

Returns:

Number The width of the sides passed added together

Gets the bottom Y coordinate of the element (element Y position + element height)

Parameters:

Boolean local

True to get the local css position instead of page coordinate

Returns:

Number

Return a box {x, y, width, height} that can be used to set another elements
size/location to match this element.

Parameters:

Boolean contentBox

(optional) If true a box for the content of the element is returned.

Boolean local

(optional) If true the element's left and top are returned instead of page x/y.

Returns:

Object box An object in the format {x, y, width, height}

Calculates the x, y to center this element on the screen

Returns:

Array The x, y values [x, y]

Return the CSS color for the specified CSS attribute. rgb, 3 digit (like fff) and valid values
are convert to standard 6 digit hex color.

Parameters:

String attr

The css attribute

String defaultValue

The default value to use when a valid color isn't found

String prefix

(optional) defaults to #. Use an empty string when working with
YUI color anims.

Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders
when needed to simulate offsetHeight when offsets aren't available. This may not work on display:none elements
if a height has not been set using CSS.

Returns:

Number

Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders
when needed to simulate offsetWidth when offsets aren't available. This may not work on display:none elements
if a width has not been set using CSS.

Returns:

Number

Returns the sum width of the padding and borders for the passed "sides". See getBorderWidth()
for more information about the sides.

Parameters:

String sides

Returns:

Number

Returns the offset height of the element

Parameters:

Boolean contentHeight

(optional) true to get the height minus borders and padding

Returns:

Number The element's height

Gets the left X coordinate

Parameters:

Boolean local

True to get the local css position instead of page coordinate

Returns:

Number

Returns an object with properties top, left, right and bottom representing the margins of this element unless sides is passed,
then it returns the calculated width of the sides (see getPadding)

Parameters:

String sides

(optional) Any combination of l, r, t, b to get the sum of those sides

Returns:

Object/Number

Gets the next sibling, skipping text nodes

Returns:

HTMLElement The next sibling or null

Gets the width of the padding(s) for the specified side(s)

Parameters:

String side

Can be t, l, r, b or any combination of those to add multiple values. For example,
passing lr would get the padding (l)eft + the padding (r)ight.

Returns:

Number The padding of the sides passed added together

Gets an object with all CSS positioning properties. Useful along with setPostioning to get
snapshot before performing an update and then restoring the element.

Returns:

Object

Gets the previous sibling, skipping text nodes

Returns:

HTMLElement The previous sibling or null

Returns the region of the given element.
The element must be part of the DOM tree to have a region (display:none or elements not appended return false).

Returns:

Region A Roo.lib.Region containing "top, left, bottom, right" member data.

Gets the right X coordinate of the element (element X position + element width)

Parameters:

Boolean local

True to get the local css position instead of page coordinate

Returns:

Number

Returns the current scroll position of the element.

Returns:

Object An object containing the scroll position in the format {left: (scrollLeft), top: (scrollTop)}

Returns the size of the element.

Parameters:

Boolean contentSize

(optional) true to get the width/size minus borders and padding

Returns:

Object An object containing the element's size {width: (element width), height: (element height)}

Normalizes currentStyle and computedStyle. This is not YUI getStyle, it is an optimised version.

Parameters:

String property

The style property whose value is returned.

Returns:

String The current value of the style property for this element.

Returns an object with properties matching the styles requested.
For example, el.getStyles('color', 'font-size', 'width') might return
{'color': 'FFFFFF', 'font-size': '13px', 'width': '100px'}.

Parameters:

String style1

A style name

String style2

A style name

String etc.

Returns:

Object The style object

Gets the top Y coordinate

Parameters:

Boolean local

True to get the local css position instead of page coordinate

Returns:

Number

Gets this element's UpdateManager

Returns:

Roo.UpdateManager The UpdateManager

Returns the value of the "value" attribute

Parameters:

Boolean asNumber

true to parse the value as a number

Returns:

String/Number

Returns the width and height of the viewport.

Returns:

Object An object containing the viewport's size {width: (viewport width), height: (viewport height)}

Returns the offset width of the element

Parameters:

Boolean contentWidth

(optional) true to get the width minus borders and padding

Returns:

Number The element's width

Gets the current 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).

Returns:

Number The X position of the element

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).

Returns:

Array The XY position of the element

Gets the current 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).

Returns:

Number The Y position of the element

Checks if the specified CSS class exists on this element's DOM node.

Parameters:

String className

The CSS class to check for

Returns:

Boolean True if the class exists, else false

Hide this element - Uses display mode to determine whether to use "display" or "visibility". See {link setVisible}.

Parameters:

Boolean/Object animate

(optional) true for the default animation or a standard Element animation config object

Returns:

Roo.Element this

Initializes a {link Roo.dd.DD} drag drop object for this element.

Parameters:

String group

The group the DD object is member of

Object config

The DD config object

Object overrides

An object containing methods to override/implement on the DD object

Returns:

Roo.dd.DD The DD object

Initializes a {link Roo.dd.DDProxy} object for this element.

Parameters:

String group

The group the DDProxy object is member of

Object config

The DDProxy config object

Object overrides

An object containing methods to override/implement on the DDProxy object

Returns:

Roo.dd.DDProxy The DDProxy object

Initializes a {link Roo.dd.DDTarget} object for this element.

Parameters:

String group

The group the DDTarget object is member of

Object config

The DDTarget config object

Object overrides

An object containing methods to override/implement on the DDTarget object

Returns:

Roo.dd.DDTarget The DDTarget object

Inserts this element after the passed element in the DOM

Parameters:

String/HTMLElement/Element el

The element to insert after

Returns:

Roo.Element this

Inserts this element before the passed element in the DOM

Parameters:

String/HTMLElement/Element el

The element to insert before

Returns:

Roo.Element this

Inserts (or creates) an element (or DomHelper config) as the first child of the this element

Parameters:

String/HTMLElement/Element/Object el

The id or element to insert or a DomHelper config to create and insert

Returns:

Roo.Element The new child

Inserts an html fragment into this element

Parameters:

String where

Where to insert the html in relation to the this element - beforeBegin, afterBegin, beforeEnd, afterEnd.

String html

The HTML fragment

Boolean returnEl

True to return an Roo.Element

Returns:

HTMLElement/Roo.Element The inserted node (or nearest related if more than 1 inserted)

Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element

Parameters:

String/HTMLElement/Element/Object el

The id or element to insert or a DomHelper config to create and insert

String where

(optional) 'before' or 'after' defaults to before

Boolean returnDom

(optional) True to return the raw DOM element instead of Roo.Element

Returns:

Roo.Element the inserted Element

Returns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child)

Parameters:

String selector

The simple selector to test

Returns:

Boolean True if this element matches the selector, else false

Tests various css rules/browsers to determine if this element uses a border box

Returns:

Boolean

Returns true if display is not "none"

Returns:

Boolean

Returns true if this element is masked

Returns:

Boolean

Returns true if this element is scrollable.

Returns:

Boolean

Checks whether the element is currently visible using both visibility and display properties.

Parameters:

Boolean deep

(optional) True to walk the dom and see if parent elements are hidden (defaults to false)

Returns:

Boolean True if the element is currently visible, else false

Direct access to the UpdateManager update() method (takes the same parameters).

Parameters:

String/Function url

The url for this request or a function to call to get the url

String/Object params

(optional) The parameters to pass as either a url encoded string "param1=1&param2=2" or an object {param1: 1, param2: 2}

Function callback

(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)

Boolean discardUrl

(optional) By default when you execute an update the defaultUrl is changed to the last used url. If true, it will not store the url.

Returns:

Roo.Element this

Puts a mask over this element to disable user interaction. Requires core.css.
This method can only be applied to elements which accept child nodes.

Parameters:

String msg

(optional) A message to display in the mask

String msgCls

(optional) A css class to apply to the msg element

Returns:

Element The mask element

Move this element relative to its current position.

Parameters:

String direction

Possible values are: "l","left" - "r","right" - "t","top","up" - "b","bottom","down".

Number distance

How far to move the element in pixels

Boolean/Object animate

(optional) true for the default animation or a standard Element animation config object

Returns:

Roo.Element this

Sets the position of the element in page coordinates, regardless of how the element is positioned.
The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).

Parameters:

Number x

X value for new position (coordinates are page-based)

Number y

Y value for new position (coordinates are page-based)

Boolean/Object animate

(optional) True for the default animation, or a standard Element animation config object

Returns:

Roo.Element this

Appends an event handler (Shorthand for addListener)

Parameters:

String eventName

The type of event to append

Function fn

The method the event invokes

Object scope

(optional) The scope (this object) of the fn

Object options

(optional)An object with standard {link Roo.EventManageraddListener} options

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:

String pos

(optional) Positioning to use "relative", "absolute" or "fixed"

Number zIndex

(optional) The zIndex to apply

Number x

(optional) Set the page X position

Number y

(optional) Set the page Y position

Selects child nodes based on the passed CSS selector (the selector should not contain an id).

Parameters:

String selector

The CSS selector

Returns:

Array An array of the matched nodes

Adds one or more CSS classes to this element and removes the same class(es) from all siblings.

Parameters:

String/Array className

The CSS class to add, or an array of classes

Returns:

Roo.Element this

Removes this element from the DOM and deletes it from the cache

Removes all previous added listeners from this element

Returns:

Roo.Element this

Removes one or more CSS classes from the element.

Parameters:

String/Array className

The CSS class to remove, or an array of classes

Returns:

Roo.Element this

Removes an event handler from this element

Parameters:

String eventName

the type of event to remove

Function fn

the method the event invokes

Returns:

Roo.Element this

Forces the browser to repaint this element

Returns:

Roo.Element this

Replaces the passed element with this element

Parameters:

String/HTMLElement/Element el

The element to replace

Returns:

Roo.Element this

Replaces a CSS class on the element with another. If the old name does not exist, the new name will simply be added.

Parameters:

String oldClassName

The CSS class to replace

String newClassName

The replacement CSS class

Returns:

Roo.Element this

Scrolls this element the specified direction. Does bounds checking to make sure the scroll is
within this element's scrollable range.

Parameters:

String direction

Possible values are: "l","left" - "r","right" - "t","top","up" - "b","bottom","down".

Number distance

How far to scroll the element in pixels

Boolean/Object animate

(optional) true for the default animation or a standard Element animation config object

Returns:

Boolean Returns true if a scroll was triggered or false if the element
was scrolled as far as it could go.

Scrolls this element into view within the passed container.

Parameters:

String/HTMLElement/Element container

(optional) The container element to scroll (defaults to document.body)

Boolean hscroll

(optional) False to disable horizontal scroll (defaults to true)

Returns:

Roo.Element this

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:

String side

Either "left" for scrollLeft values or "top" for scrollTop values.

Number value

The new scroll value

Boolean/Object animate

(optional) true for the default animation or a standard Element animation config object

Returns:

Element this

Creates a {link Roo.CompositeElement} for child nodes based on the passed CSS selector (the selector should not contain an id).

Parameters:

String selector

The CSS selector

Boolean unique

(optional) True to create a unique Roo.Element for each child (defaults to false, which creates a single shared flyweight object)

Returns:

CompositeElement/CompositeElementLite The composite element

Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function)

Parameters:

Object o

The object with the attributes

Boolean useSet

(optional) false to override the default setAttribute to use expandos.

Returns:

Roo.Element this

Sets the element's CSS bottom style.

Parameters:

String bottom

The bottom CSS property value

Returns:

Roo.Element this

Sets the element's position and size in one shot. If animation is true then width, height, x and y will be animated concurrently.

Parameters:

Number x

X value for new position (coordinates are page-based)

Number y

Y value for new position (coordinates are page-based)

Number width

The new width

Number height

The new height

Boolean/Object animate

(optional) true for the default animation or a standard Element animation config object

Returns:

Roo.Element this

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.

Parameters:

Object box

The box to fill {x, y, width, height}

Boolean adjust

(optional) Whether to adjust for box-model issues automatically

Boolean/Object animate

(optional) true for the default animation or a standard Element animation config object

Returns:

Roo.Element this

Sets the CSS display property. Uses originalDisplay if the specified value is a boolean true.

Parameters:

Boolean value

Boolean value to display the element using its default display, or a string to set the display directly

Returns:

Roo.Element this

Set the height of the element

Parameters:

Number height

The new height

Boolean/Object animate

(optional) true for the default animation or a standard Element animation config object

Returns:

Roo.Element this

Sets the element's left position directly using CSS style (instead of {link setX}).

Parameters:

String left

The left CSS property value

Returns:

Roo.Element this

Quick set left and top adding default units

Parameters:

String left

The left CSS property value

String top

The top CSS property value

Returns:

Roo.Element this

Sets the position of the element in page coordinates, regardless of how the element is positioned.
The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).

Parameters:

Number x

X value for new position (coordinates are page-based)

Number y

Y value for new position (coordinates are page-based)

Boolean/Object animate

(optional) True for the default animation, or a standard Element animation config object

Returns:

Roo.Element this

Set the opacity of the element

Parameters:

Float opacity

The new opacity. 0 = transparent, .5 = 50% visibile, 1 = fully visible, etc

Boolean/Object animate

(optional) true for the default animation or a standard Element animation config object

Returns:

Roo.Element this

Set positioning with an object returned by getPositioning().

Parameters:

Object posCfg

Returns:

Roo.Element this

Sets the element's position and size the the specified region. If animation is true then width, height, x and y will be animated concurrently.

Parameters:

Roo.lib.Region region

The region to fill

Boolean/Object animate

(optional) true for the default animation or a standard Element animation config object

Returns:

Roo.Element this

Sets the element's CSS right style.

Parameters:

String right

The right CSS property value

Returns:

Roo.Element this

Set the size of the element. If animation is true, both width an height will be animated concurrently.

Parameters:

Number width

The new width

Number height

The new height

Boolean/Object animate

(optional) true for the default animation or a standard Element animation config object

Returns:

Roo.Element this

Wrapper for setting style properties, also takes single object parameter of multiple styles.

Parameters:

String/Object property

The style property to be set, or an object of multiple styles.

String value

(optional) The value to apply to the given property, or null if an object was passed.

Returns:

Roo.Element this

Sets the element's top position directly using CSS style (instead of {link setY}).

Parameters:

String top

The top CSS property value

Returns:

Roo.Element this

Sets the element's visibility mode. When setVisible() is called it
will use this to determine whether to set the visibility or the display property.

Parameters:

visMode

Element.VISIBILITY or Element.DISPLAY

Returns:

Roo.Element this

Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use
the display property to hide the element, otherwise it uses visibility. The default is to hide and show using the visibility property.

Parameters:

Boolean visible

Whether the element is visible

Boolean/Object animate

(optional) True for the default animation, or a standard Element animation config object

Returns:

Roo.Element this

Set the width of the element

Parameters:

Number width

The new width

Boolean/Object animate

(optional) true for the default animation or a standard Element animation config object

Returns:

Roo.Element this

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).

Parameters:

Number The

X position of the element

Boolean/Object animate

(optional) True for the default animation, or a standard Element animation config object

Returns:

Roo.Element this

Sets the position of the element in page coordinates, regardless of how the element is positioned.
The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).

Parameters:

Array pos

Contains X & Y [x, y] values for new position (coordinates are page-based)

Boolean/Object animate

(optional) True for the default animation, or a standard Element animation config object

Returns:

Roo.Element this

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).

Parameters:

Number The

Y position of the element

Boolean/Object animate

(optional) True for the default animation, or a standard Element animation config object

Returns:

Roo.Element this

Show this element - Uses display mode to determine whether to use "display" or "visibility". See {link setVisible}.

Parameters:

Boolean/Object animate

(optional) true for the default animation or a standard Element animation config object

Returns:

Roo.Element this

Stops the specified event from bubbling and optionally prevents the default action

Parameters:

String eventName

Boolean preventDefault

(optional) true to prevent the default action too

Returns:

Roo.Element this

Toggles the element's visibility or display, depending on visibility mode.

Parameters:

Boolean/Object animate

(optional) True for the default animation, or a standard Element animation config object

Returns:

Roo.Element this

Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it).

Parameters:

String className

The CSS class to toggle

Returns:

Roo.Element this

Translates the passed page coordinates into left/top css values for this element

Parameters:

Number/Array x

The page x or an array containing [x, y]

Number y

The page y

Returns:

Object An object with left and top properties. e.g. {left: (value), top: (value)}

Removes an event handler from this element (shorthand for removeListener)

Parameters:

String eventName

the type of event to remove

Function fn

the method the event invokes

Returns:

Roo.Element this

Return clipping (overflow) to original clipping before clip() was called

Returns:

Roo.Element this

Removes a previously applied mask. If removeEl is true the mask overlay is destroyed, otherwise
it is cached for reuse.

Disables text selection for this element (normalized across browsers)

Returns:

Roo.Element this

Walks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first-child).
This is a shortcut for findParentNode() that always returns an Roo.Element.

Parameters:

String selector

The simple selector to test

Number/String/HTMLElement/Element maxDepth

(optional) The max depth to
search as a number or element (defaults to 10 || document.body)

Returns:

Roo.Element The matching DOM node (or null if no match was found)

Update the innerHTML of this element, optionally searching for and processing scripts

Parameters:

String html

The new HTML

Boolean loadScripts

(optional) true to look for and process scripts

Function callback

For async script loading you can be noticed when the update completes

Returns:

Roo.Element this

Creates and wraps this element with another element

Parameters:

Object config

(optional) DomHelper element config object for the wrapper element or null for an empty div

Boolean returnDom

(optional) True to return the raw DOM element instead of Roo.Element

Returns:

HTMLElement/Element The newly created wrapper element