/* This file is part of Ext JS 3.4 Copyright (c) 2011-2013 Sencha Inc Contact: http://www.sencha.com/contact GNU General Public License Usage This file may be used under the terms of the GNU General Public License version 3.0 as published by the Free Software Foundation and appearing in the file LICENSE included in the packaging of this file. Please review the following information to ensure the GNU General Public License version 3.0 requirements will be met: http://www.gnu.org/copyleft/gpl.html. If you are unsure which license is appropriate for your use, please contact the sales department at http://www.sencha.com/contact. Build date: 2013-04-03 15:07:25 */ Ext.data.JsonP.Ext_state_Provider({"alternateClassNames":[],"aliases":{},"enum":null,"parentMixins":[],"tagname":"class","subclasses":["Ext.state.CookieProvider"],"extends":"Ext.util.Observable","uses":[],"html":"
Hierarchy
Ext.util.Observable
Ext.state.Provider
Subclasses
Ext.state.CookieProvider
Files
Provider.js

Abstract base class for state provider implementations. This class provides methods\nfor encoding and decoding typed variables including dates and defines the\nProvider interface.

\n
Defined By

Config options

Ext.util.Observable
view source
: Object
(optional) A config object containing one or more event handlers to be added to this\nobject during initialization. ...

(optional)

A config object containing one or more event handlers to be added to this\nobject during initialization. This should be a valid listeners config object as specified in the\naddListener example for attaching multiple handlers at once.

\n\n

DOM events from ExtJs Components

\n\n\n

While some ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this\n\n\n

is usually only done when extra value can be added. For example the DataView's\nclick event passing the node clicked on. To access DOM\nevents directly from a Component's HTMLElement, listeners must be added to the Element after the Component\nhas been rendered. A plugin can simplify this step:

\n\n
// Plugin is configured with a listeners config object.\n// The Component is appended to the argument list of all handler functions.\nExt.DomObserver = Ext.extend(Object, {\n    constructor: function(config) {\n        this.listeners = config.listeners ? config.listeners : config;\n    },\n\n    // Component passes itself into plugin's init method\n    init: function(c) {\n        var p, l = this.listeners;\n        for (p in l) {\n            if (Ext.isFunction(l[p])) {\n                l[p] = this.createHandler(l[p], c);\n            } else {\n                l[p].fn = this.createHandler(l[p].fn, c);\n            }\n        }\n\n        // Add the listeners to the Element immediately following the render call\n        c.render = c.render.createSequence(function() {\n            var e = c.getEl();\n            if (e) {\n                e.on(l);\n            }\n        });\n    },\n\n    createHandler: function(fn, c) {\n        return function(e) {\n            fn.call(this, e, c);\n        };\n    }\n});\n\nvar combo = new Ext.form.ComboBox({\n\n    // Collapse combo when its element is clicked on\n    plugins: [ new Ext.DomObserver({\n        click: function(evt, comp) {\n            comp.collapse();\n        }\n    })],\n    store: myStore,\n    typeAhead: true,\n    mode: 'local',\n    triggerAction: 'all'\n});\n
\n\n\n

\n
Defined By

Properties

Ext.state.Provider
view source
: RegExp
a -> Array\nn -> Number\nd -> Date\nb -> Boolean\ns -> String\no -> Object\n-> Empty (null) ...

a -> Array\nn -> Number\nd -> Date\nb -> Boolean\ns -> String\no -> Object\n-> Empty (null)

\n

Defaults to: /^(a|n|d|b|s|o|e)\\:(.*)$/

Defined By

Methods

Ext.util.Observable
view source
( o, Optional )
Adds the specified events to the list of events which this Observable may fire. ...

Adds the specified events to the list of events which this Observable may fire.

\n

Parameters

  • o : Object|String

    Either an object with event names as properties with a value of true\nor the first event name string if multiple event names are being passed as separate parameters.

    \n
  • Optional : string

    . Event name if multiple event names are being passed as separate parameters.\nUsage:

    \n\n
    this.addEvents('storeloaded', 'storecleared');\n
    \n\n
Ext.util.Observable
view source
( eventName, handler, [scope], [options] )
Appends an event handler to this object. ...

Appends an event handler to this object.

\n

Parameters

  • eventName : String

    The name of the event to listen for.

    \n
  • handler : Function

    The method the event invokes.

    \n
  • scope : Object (optional)

    The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.

    \n
  • options : Object (optional)

    An object containing handler configuration.\nproperties. This may contain any of the following properties:

      \n
    • scope : Object
      The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
      • \n
    • delay : Number
      The number of milliseconds to delay the invocation of the handler after the event fires.
      • \n
    • single : Boolean
      True to add a handler to handle just the next firing of the event, and then remove itself.
      • \n
    • buffer : Number
      Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
      • \n
    • target : Observable
      Only call the handler if the event was fired on the target Observable, not\nif the event was bubbled up from a child Observable.
      • \n

    \n\n

    \nCombining Options
    \nUsing the options argument, it is possible to combine different types of listeners:
    \n
    \nA delayed, one-time listener.\n

    myDataView.on('click', this.onClick, this, {\nsingle: true,\ndelay: 100\n});
    \n

    \nAttaching multiple handlers in 1 call
    \nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

    \n

    myGridPanel.on({\n'click' : {\n    fn: this.onClick,\n    scope: this,\n    delay: 100\n},\n'mouseover' : {\n    fn: this.onMouseOver,\n    scope: this\n},\n'mouseout' : {\n    fn: this.onMouseOut,\n    scope: this\n}\n});
    \n

    \nOr a shorthand syntax:
    \n

    myGridPanel.on({\n'click' : this.onClick,\n'mouseover' : this.onMouseOver,\n'mouseout' : this.onMouseOut,\n scope: this\n});
    \n\n

Ext.state.Provider
view source
( name )
Clears a value from the state ...

Clears a value from the state

\n

Parameters

Ext.state.Provider
view source
( value ) : Mixed
Decodes a string previously encoded with encodeValue. ...

Decodes a string previously encoded with encodeValue.

\n

Parameters

  • value : String

    The value to decode

    \n

Returns

  • Mixed

    The decoded value

    \n
Ext.util.Observable
view source
( events )
Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present. ...

Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present. There is no implementation in the Observable base class.

\n\n\n

This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default\nimplementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.

\n\n\n

Example:

\n\n\n
Ext.override(Ext.form.Field, {\n    //  Add functionality to Field's initComponent to enable the change event to bubble\n    initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {\n        this.enableBubble('change');\n    }),\n\n    //  We know that we want Field's events to bubble directly to the FormPanel.\n    getBubbleTarget : function() {\n        if (!this.formPanel) {\n            this.formPanel = this.findParentByType('form');\n        }\n        return this.formPanel;\n    }\n});\n\nvar myForm = new Ext.formPanel({\n    title: 'User Details',\n    items: [{\n        ...\n    }],\n    listeners: {\n        change: function() {\n            // Title goes red if form has been modified.\n            myForm.header.setStyle('color', 'red');\n        }\n    }\n});\n
\n\n

Parameters

  • events : String/Array

    The event name to bubble, or an Array of event names.

    \n
Ext.state.Provider
view source
( value ) : String
Encodes a value including type information. ...

Encodes a value including type information. Decode with decodeValue.

\n

Parameters

  • value : Mixed

    The value to encode

    \n

Returns

Ext.util.Observable
view source
( eventName, args ) : Boolean
Fires the specified event with the passed parameters (minus the event name). ...

Fires the specified event with the passed parameters (minus the event name).

\n\n\n

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget)\nby calling enableBubble.

\n\n

Parameters

  • eventName : String

    The name of the event to fire.

    \n
  • args : Object...

    Variable number of parameters are passed to handlers.

    \n

Returns

  • Boolean

    returns false if any of the handlers return false otherwise it returns true.

    \n
Ext.state.Provider
view source
( name, defaultValue ) : Mixed
Returns the current value for a key ...

Returns the current value for a key

\n

Parameters

  • name : String

    The key name

    \n
  • defaultValue : Mixed

    A default value to return if the key's value is not found

    \n

Returns

  • Mixed

    The state data

    \n
Ext.util.Observable
view source
( eventName ) : Boolean
Checks to see if this object has any listeners for a specified event ...

Checks to see if this object has any listeners for a specified event

\n

Parameters

  • eventName : String

    The name of the event to check for

    \n

Returns

  • Boolean

    True if the event is being listened for, else false

    \n
Ext.util.Observable
view source
( eventName, handler, [scope], [options] )
Appends an event handler to this object (shorthand for addListener.) ...

Appends an event handler to this object (shorthand for addListener.)

\n

Parameters

  • eventName : String

    The type of event to listen for

    \n
  • handler : Function

    The method the event invokes

    \n
  • scope : Object (optional)

    The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.

    \n
  • options : Object (optional)

    An object containing handler configuration.

    \n
Ext.util.Observable
view source
( )
Removes all listeners for this object ...

Removes all listeners for this object

\n
Ext.util.Observable
view source
( o, events )
Relays selected events from the specified Observable as if the events were fired by this. ...

Relays selected events from the specified Observable as if the events were fired by this.

\n

Parameters

  • o : Object

    The Observable whose events this object is to relay.

    \n
  • events : Array

    Array of event names to relay.

    \n
Ext.util.Observable
view source
( eventName, handler, [scope] )
Removes an event handler. ...

Removes an event handler.

\n

Parameters

  • eventName : String

    The type of event the handler was associated with.

    \n
  • handler : Function

    The handler to remove. This must be a reference to the function passed into the addListener call.

    \n
  • scope : Object (optional)

    The scope originally specified for the handler.

    \n
Ext.util.Observable
view source
( )
Resume firing events. ...

Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevents fired during event suspension will be sent to any listeners now.

\n
Ext.state.Provider
view source
( name, value )
Sets the value for a key ...

Sets the value for a key

\n

Parameters

  • name : String

    The key name

    \n\n
  • value : Mixed

    The value to set

    \n\n
Ext.util.Observable
view source
( queueSuspended )
Suspend the firing of all events. ...

Suspend the firing of all events. (see resumeEvents)

\n

Parameters

  • queueSuspended : Boolean

    Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events;

    \n
Ext.util.Observable
view source
( eventName, handler, [scope] )
Removes an event handler (shorthand for removeListener.) ...

Removes an event handler (shorthand for removeListener.)

\n

Parameters

  • eventName : String

    The type of event the handler was associated with.

    \n
  • handler : Function

    The handler to remove. This must be a reference to the function passed into the addListener call.

    \n
  • scope : Object (optional)

    The scope originally specified for the handler.

    \n
Defined By

Events

Ext.state.Provider
view source
( this, key, value )
Fires when a state change occurs. ...

Fires when a state change occurs.

\n

Parameters

  • this : Provider

    This state provider

    \n
  • key : String

    The state key which was changed

    \n
  • value : String

    The encoded value for the state

    \n
","superclasses":["Ext.util.Observable"],"meta":{},"requires":[],"html_meta":{},"statics":{"property":[],"cfg":[],"css_var":[],"method":[],"event":[],"css_mixin":[]},"files":[{"href":"Provider2.html#Ext-state-Provider","filename":"Provider.js"}],"linenr":1,"members":{"property":[{"tagname":"property","owner":"Ext.state.Provider","meta":{},"name":"re","id":"property-re"}],"cfg":[{"tagname":"cfg","owner":"Ext.util.Observable","meta":{},"name":"listeners","id":"cfg-listeners"}],"css_var":[],"method":[{"tagname":"method","owner":"Ext.state.Provider","meta":{},"name":"constructor","id":"method-constructor"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"addEvents","id":"method-addEvents"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"addListener","id":"method-addListener"},{"tagname":"method","owner":"Ext.state.Provider","meta":{},"name":"clear","id":"method-clear"},{"tagname":"method","owner":"Ext.state.Provider","meta":{},"name":"decodeValue","id":"method-decodeValue"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"enableBubble","id":"method-enableBubble"},{"tagname":"method","owner":"Ext.state.Provider","meta":{},"name":"encodeValue","id":"method-encodeValue"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"fireEvent","id":"method-fireEvent"},{"tagname":"method","owner":"Ext.state.Provider","meta":{},"name":"get","id":"method-get"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"hasListener","id":"method-hasListener"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"on","id":"method-on"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"purgeListeners","id":"method-purgeListeners"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"relayEvents","id":"method-relayEvents"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"removeListener","id":"method-removeListener"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"resumeEvents","id":"method-resumeEvents"},{"tagname":"method","owner":"Ext.state.Provider","meta":{},"name":"set","id":"method-set"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"suspendEvents","id":"method-suspendEvents"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"un","id":"method-un"}],"event":[{"tagname":"event","owner":"Ext.state.Provider","meta":{},"name":"statechange","id":"event-statechange"}],"css_mixin":[]},"inheritable":null,"private":null,"component":false,"name":"Ext.state.Provider","singleton":false,"override":null,"inheritdoc":null,"id":"class-Ext.state.Provider","mixins":[],"mixedInto":[]});