X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/src/AbstractPlugin.js diff --git a/src/AbstractPlugin.js b/src/AbstractPlugin.js index 01668ade..01f11b89 100644 --- a/src/AbstractPlugin.js +++ b/src/AbstractPlugin.js @@ -13,20 +13,23 @@ If you are unsure which license is appropriate for your use, please contact the */ /** - * @class Ext.AbstractPlugin - * @extends Object + * The AbstractPlugin class is the base class from which user-implemented plugins should inherit. * - *

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:

- * + * 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', { disabled: false, @@ -45,32 +48,37 @@ Ext.define('Ext.AbstractPlugin', { }, /** - *

The init method is invoked after {@link Ext.Component#initComponent initComponent} 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 {Component} client The client Component which owns this plugin. * @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, /** - *

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.

* @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, /** - *

The base implementation just sets the plugin's disabled flag to false

- *

Plugin subclasses which need more complex processing may implement an overriding implementation.

+ * 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; }, /** - *

The base implementation just sets the plugin's disabled flag to true

- *

Plugin subclasses which need more complex processing may implement an overriding implementation.

+ * 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;