API: plugin Plugin (YUI Library)

Class Plugin - extends Base

Plugin provides a base class for all Plugin classes.

Properties

Plugin.NAME - `static {String}`

Static property provides a string to identify the class.

Plugin.NS - `static {String}`

Static property provides the namespace the plugin will be registered under.

Properties inherited from Attribute:

Properties inherited from Base:


                                    
                                        
                                        name

Methods

destructor

desctructor lifecycle implementation. Removes any listeners attached by the Plugin and restores and over-ridden methods.

Returns: void

doAfter

Listens for events and methods fired by the owner widget. The handler is called after the event handler or method is called.

Parameters:: sFn <object> The event of method to listen for.; fn <object> The handler function to call when the listener fires.; context <object> An optional context to call the handler with. Default context is the plugin instance.

doBefore

Listens for events and methods fired by the owner widget. The handler is called before the event handler or method is called.

Parameters:: sFn <object> The event of method to listen for.; fn <object> The handler function to call when the listener fires.; context <object> An optional context to call the handler with. Default context is the plugin instance.

initializer


                                        
                                        
                                        
                                        void
                                            initializer
                                           (
                                                
                                                        
                                                         config
                                                    
                                                
                                            )

Initializer lifecycle implementation.

Parameters:: config <Object> Configuration object literal for the plugin

Returns: void

Methods inherited from Attribute:


                                                                                    
                                            _cloneAttVal,
                                            
                                                                                    
                                            _defAttSet,
                                            
                                                                                    
                                            _fireAttChange,
                                            
                                                                                    
                                            _getSubAttVal,
                                            
                                                                                    
                                            _initAtts,
                                            
                                                                                    
                                            _initAttVal,
                                            
                                                                                    
                                            _set,
                                            
                                                                                    
                                            _setSubAttVal,
                                            
                                                                                    
                                            _splitAttrValues,
                                            
                                                                                    
                                            addAtt,
                                            
                                                                                    
                                            get,
                                            
                                                                                    
                                            getAtts,
                                            
                                                                                    
                                            on,
                                            
                                                                                    
                                            removeAtt,
                                            
                                                                                    
                                            reset,
                                            
                                                                                    
                                            set,
                                            
                                                                                    
                                            setAtts

Methods inherited from Base:


                                                                                    
                                            _defDestroyFn,
                                            
                                                                                    
                                            _defInitFn,
                                            
                                                                                    
                                            _destroyHierarchy,
                                            
                                                                                    
                                            _getClasses,
                                            
                                                                                    
                                            _initHierarchy,
                                            
                                                                                    
                                            _prefixEvtType,
                                            
                                                                                    
                                            after,
                                            
                                                                                    
                                            destroy,
                                            
                                                                                    
                                            fire,
                                            
                                                                                    
                                            init,
                                            
                                                                                    
                                            publish,
                                            
                                                                                    
                                            subscribe,
                                            
                                                                                    
                                            toString,
                                            
                                                                                    
                                            unsubscribe,
                                            
                                                                                    
                                            unsubscribeAll

Methods inherited from Event.Target:


                                                                                    
                                            addTarget,
                                            
                                                                                    
                                            after,
                                            
                                                                                    
                                            bubble,
                                            
                                                                                    
                                            fire,
                                            
                                                                                    
                                            getEvent,
                                            
                                                                                    
                                            publish,
                                            
                                                                                    
                                            removeTarget,
                                            
                                                                                    
                                            subscribe,
                                            
                                                                                    
                                            unsubscribe,
                                            
                                                                                    
                                            unsubscribeAll

Events inherited from Base:


                                        
                                        destroy,
                                        
                                                                            
                                        destroyedChange,
                                        
                                                                            
                                        init,
                                        
                                                                            
                                        initializedChange,

Configuration attributes inherited from Base:


                                                                                
                                        destroyed,
                                        
                                                                                                                        
                                        initialized,

Yahoo! UI Library

plugin 3.0.0pr2

Class Plugin - extends Base

Properties

Plugin.NAME - `static {String}`

Plugin.NS - `static {String}`

Properties inherited from Attribute:

Properties inherited from Base:

Methods

destructor

doAfter

doBefore

initializer

Methods inherited from Attribute:

Methods inherited from Base:

Methods inherited from Event.Target:

Events inherited from Base:

Configuration attributes inherited from Base:

Modules

Classes

Files

Properties

Methods

Yahoo! UI Library

plugin 3.0.0pr2

Class Plugin - extends Base

Properties

Plugin.NAME - static {String}

Plugin.NS - static {String}

Properties inherited from Attribute:

Properties inherited from Base:

Methods

destructor

doAfter

doBefore

initializer

Methods inherited from Attribute:

Methods inherited from Base:

Methods inherited from Event.Target:

Events inherited from Base:

Configuration attributes inherited from Base:

Modules

Classes

Files

Properties

Methods

Plugin.NAME - `static {String}`

Plugin.NS - `static {String}`