Class Roo

Applies event listeners to elements by selectors when the document is ready.
The event name is specified with an @ suffix.

Roo.addBehaviors({
   // add a listener for click on all anchors in element with id foo
   'foo aclick' : function(e, t){
       // do something
   },

   // add the same listener to multiple selectors (separated by comma BEFORE the @)
   'foo a, bar span.some-classmouseover' : function(){
       // do something
   }
});

Parameters:

Object obj

The list of behaviors to apply

Copies all the properties of config to obj.

Parameters:

Object obj

The receiver of the properties

Object config

The source of the properties

Object defaults

A different object that will also be applied for default values

Returns:

Object returns obj

Copies all the properties of config to obj if they don't already exist.

Parameters:

Object obj

The receiver of the properties

Object config

The source of the properties

Returns:

Object returns obj

Shorthand for {link Roo.util.JSONdecode}

Iterates an array calling the passed function with each item, stopping if your function returns false. If the
passed array is not really an array, your function is called once with it.
The supplied function is called with (Object item, Number index, Array allItems).

Parameters:

Array/NodeList/Mixed array

Function fn

Object scope

Shorthand for {link Roo.util.JSONencode}

Safe version of encodeURIComponent

Parameters:

String data

Returns:

String

Escapes the passed string for use in a regular expression

Parameters:

String str

Returns:

String

Extends one class with another class and optionally overrides members with the passed literal. This class
also adds the function "override()" to the class that can be used to override
members on an instance.

Parameters:

Object subclass

The class inheriting the functionality

Object superclass

The class being extended

Object overrides

(optional) A literal with members

Creates namespaces to be used for scoping variables and classes so that they are not global. Usage:

Roo.factory({ xns: Roo.data, xtype : 'Store', .....});
Roo.factory(conf, Roo.data);

Parameters:

String classname

String namespace

(optional)

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 {link Roo.Elementfly}

Parameters:

String/HTMLElement el

The dom node or id

String named

(optional) Allows for creation of named reusable flyweights to
prevent conflicts (e.g. internally Roo uses "_internal")

Returns:

Element The shared Element object

Static method to retrieve Element objects. Uses simple caching to consistently return the same object.
Automatically fixes if an object was recreated with the same id via AJAX or DOM.
Shorthand of {link Roo.Elementget}

Parameters:

String/HTMLElement/Element el

The id of the node, a DOM Node or an existing Element.

Returns:

Element The Element object

Shorthand for {link Roo.ComponentMgrget}

Parameters:

String id

Returns:

Roo.Component

Return the dom node for the passed string (id), dom node, or Roo.Element

Parameters:

String/HTMLElement/Roo.Element el

Returns:

HTMLElement

Generates unique ids. If the element already has an id, it is unchanged

Parameters:

String/HTMLElement/Element el

(optional) The element to generate an id for

String prefix

(optional) Id prefix (defaults "Roo-gen")

Returns:

String The generated Id.

Returns true if the passed value is null, undefined or an empty string (optional).

Parameters:

Mixed value

The value to test

Boolean allowBlank

(optional) Pass true if an empty string is not considered empty

Returns:

Boolean

Creates namespaces to be used for scoping variables and classes so that they are not global. Usage:

Roo.namespace('Company', 'Company.data');
Company.Widget = function() { ... }
Company.data.CustomStore = function(config) { ... }

Parameters:

String namespace1

String namespace2

String etc

Fires when the document is ready (before onload and before images are loaded). Shorthand of {link Roo.EventManageronDocumentReady}.

Parameters:

Function fn

The method the event invokes

Object scope

An object that becomes the scope of the handler

boolean override

If true, the obj passed in becomes
the execution scope of the listener

Adds a list of functions to the prototype of an existing class, overwriting any existing methods with the same name.
Usage:

Roo.override(MyClass, {
    newMethod1: function(){
        // etc.
    },
    newMethod2: function(foo){
        // etc.
    }
});
 

Parameters:

Object origclass

The class to override

Object overrides

The list of functions to add to origClass. This should be specified as an object literal
containing one or more methods.

Selects an array of DOM nodes by CSS/XPath selector. Shorthand of {link Roo.DomQueryselect}

Parameters:

String path

The selector/xpath query

Node root

(optional) The start of the query (defaults to document).

Returns:

Array

Selects elements based on the passed CSS selector to enable working on them as 1.

Parameters:

String/Array selector

The CSS selector or an array of elements

Boolean unique

(optional) true to create a unique Roo.Element for each element (defaults to a shared flyweight object)

HTMLElement/String root

(optional) The root element of the query or id of the root

Returns:

CompositeElementLite/CompositeElement

Selects a single element as a Roo Element
This is about as close as you can get to jQuery's $('do crazy stuff')

Parameters:

String selector

The selector/xpath query

Node root

(optional) The start of the query (defaults to document).

Returns:

Roo.Element

Returns the type of object that is passed in. If the object passed in is null or undefined it
return false otherwise it returns one of the following values:

• string: If the object passed is a string


• number: If the object passed is a number


• boolean: If the object passed is a boolean value


• function: If the object passed is a function reference


• object: If the object passed is an object


• array: If the object passed is an array


• regexp: If the object passed is a regular expression


• element: If the object passed is a DOM Element


• nodelist: If the object passed is a DOM NodeList


• textnode: If the object passed is a DOM text node and contains something other than whitespace


• whitespace: If the object passed is a DOM text node and contains only whitespace

Parameters:

Mixed object

Returns:

String

Takes an encoded URL and and converts it to an object. e.g. Roo.urlDecode("foo=1&bar=2"); would return {foo: 1, bar: 2} or Roo.urlDecode("foo=1&bar=2&bar=3&bar=4", true); would return {foo: 1, bar: [2, 3, 4]}.

Parameters:

String string

Boolean overwrite

(optional) Items of the same name will overwrite previous values instead of creating an an array (Defaults to false).

Returns:

Object A literal with members

Takes an object and converts it to an encoded URL. e.g. Roo.urlEncode({foo: 1, bar: 2}); would return "foo=1&bar=2". Optionally, property values can be arrays, instead of keys and the resulting string that's returned will contain a name/value pair for each array value.

Parameters:

Object o

Returns:

String