<!DOCTYPE html>
|
<html>
|
<head>
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
<title>The source code</title>
|
<link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
|
<script type="text/javascript" src="../resources/prettify/prettify.js"></script>
|
<style type="text/css">
|
.highlight { display: block; background-color: #ddd; }
|
</style>
|
<script type="text/javascript">
|
function highlight() {
|
document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
|
}
|
</script>
|
</head>
|
<body onload="prettyPrint(); highlight();">
|
<pre class="prettyprint lang-js"><span id='Ext-AbstractPlugin'>/**
|
</span> * The AbstractPlugin class is the base class from which user-implemented plugins should inherit.
|
*
|
* This class defines the essential API of plugins as used by Components by defining the following methods:
|
*
|
* - `init` : The plugin initialization method which the owning Component calls at Component initialization time.
|
*
|
* The Component passes itself as the sole parameter.
|
*
|
* Subclasses should set up bidirectional links between the plugin and its client Component here.
|
*
|
* - `destroy` : The plugin cleanup method which the owning Component calls at Component destruction time.
|
*
|
* Use this method to break links between the plugin and the Component and to free any allocated resources.
|
*
|
* - `enable` : The base implementation just sets the plugin's `disabled` flag to `false`
|
*
|
* - `disable` : The base implementation just sets the plugin's `disabled` flag to `true`
|
*/
|
Ext.define('Ext.AbstractPlugin', {
|
<span id='Ext-AbstractPlugin-property-disabled'> disabled: false,
|
</span>
|
<span id='Ext-AbstractPlugin-property-isPlugin'> /**
|
</span> * @property {Boolean} isPlugin
|
* `true` in this class to identify an object as an instantiated Plugin, or subclass thereof.
|
*/
|
isPlugin: true,
|
|
<span id='Ext-AbstractPlugin-method-constructor'> /**
|
</span> * Instantiates the plugin.
|
* @param {Object} [config] Configuration object.
|
*/
|
constructor: function(config) {
|
this.pluginConfig = config;
|
Ext.apply(this, config);
|
},
|
|
<span id='Ext-AbstractPlugin-method-clonePlugin'> /**
|
</span> * Creates clone of the plugin.
|
* @param {Object} [overrideCfg] Additional config for the derived plugin.
|
*/
|
clonePlugin: function(overrideCfg) {
|
return new this.self(Ext.apply({}, overrideCfg, this.pluginConfig));
|
},
|
|
<span id='Ext-AbstractPlugin-method-setCmp'> /**
|
</span> * Sets the component to which this plugin is attached.
|
* @param {Ext.Component} cmp Owner component.
|
*/
|
setCmp: function(cmp) {
|
this.cmp = cmp;
|
},
|
|
<span id='Ext-AbstractPlugin-method-getCmp'> /**
|
</span> * Returns the component to which this plugin is attached.
|
* @return {Ext.Component} Owner component.
|
*/
|
getCmp: function() {
|
return this.cmp;
|
},
|
|
<span id='Ext-AbstractPlugin-cfg-pluginId'> /**
|
</span> * @cfg {String} pluginId
|
* A name for the plugin that can be set at creation time to then retrieve the plugin
|
* through {@link Ext.AbstractComponent#getPlugin getPlugin} method. For example:
|
*
|
* var grid = Ext.create('Ext.grid.Panel', {
|
* plugins: [{
|
* ptype: 'cellediting',
|
* clicksToEdit: 2,
|
* pluginId: 'cellplugin'
|
* }]
|
* });
|
*
|
* // later on:
|
* var plugin = grid.getPlugin('cellplugin');
|
*/
|
|
<span id='Ext-AbstractPlugin-method-init'> /**
|
</span> * @method
|
* The init method is invoked after initComponent method has been run for the client Component.
|
*
|
* The supplied implementation is empty. Subclasses should perform plugin initialization, and set up bidirectional
|
* links between the plugin and its client Component in their own implementation of this method.
|
* @param {Ext.Component} client The client Component which owns this plugin.
|
*/
|
init: Ext.emptyFn,
|
|
<span id='Ext-AbstractPlugin-method-destroy'> /**
|
</span> * @method
|
* The destroy method is invoked by the owning Component at the time the Component is being destroyed.
|
*
|
* The supplied implementation is empty. Subclasses should perform plugin cleanup in their own implementation of
|
* this method.
|
*/
|
destroy: Ext.emptyFn,
|
|
<span id='Ext-AbstractPlugin-method-enable'> /**
|
</span> * The base implementation just sets the plugin's `disabled` flag to `false`
|
*
|
* Plugin subclasses which need more complex processing may implement an overriding implementation.
|
*/
|
enable: function() {
|
this.disabled = false;
|
},
|
|
<span id='Ext-AbstractPlugin-method-disable'> /**
|
</span> * The base implementation just sets the plugin's `disabled` flag to `true`
|
*
|
* Plugin subclasses which need more complex processing may implement an overriding implementation.
|
*/
|
disable: function() {
|
this.disabled = true;
|
},
|
|
<span id='Ext-AbstractPlugin-method-onClassExtended'> // Private.
|
</span> // Inject a ptype property so that AbstractComponent.findPlugin(ptype) works.
|
onClassExtended: function(cls, data, hooks) {
|
var alias = data.alias;
|
|
// No ptype built into the class
|
if (alias && !data.ptype) {
|
if (Ext.isArray(alias)) {
|
alias = alias[0];
|
}
|
cls.prototype.ptype = alias.split('plugin.')[1];
|
}
|
}
|
});</pre>
|
</body>
|
</html>
|
