X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..HEAD:/src/slider/Tip.js diff --git a/src/slider/Tip.js b/src/slider/Tip.js index c00495eb..da2aa62e 100644 --- a/src/slider/Tip.js +++ b/src/slider/Tip.js @@ -13,46 +13,44 @@ If you are unsure which license is appropriate for your use, please contact the */ /** - * @class Ext.slider.Tip - * @extends Ext.tip.Tip - * Simple plugin for using an Ext.tip.Tip with a slider to show the slider value. In general this - * class is not created directly, instead pass the {@link Ext.slider.Multi#useTips} and - * {@link Ext.slider.Multi#tipText} configuration options to the slider directly. - * {@img Ext.slider.Tip/Ext.slider.Tip1.png Ext.slider.Tip component} - * Example usage: -
-    Ext.create('Ext.slider.Single', {
-        width: 214,
-        minValue: 0,
-        maxValue: 100,
-        useTips: true,
-        renderTo: Ext.getBody()
-    });   
-
+ * Simple plugin for using an Ext.tip.Tip with a slider to show the slider value. In general this class is not created + * directly, instead pass the {@link Ext.slider.Multi#useTips} and {@link Ext.slider.Multi#tipText} configuration + * options to the slider directly. + * + * @example + * Ext.create('Ext.slider.Single', { + * width: 214, + * minValue: 0, + * maxValue: 100, + * useTips: true, + * renderTo: Ext.getBody() + * }); + * * Optionally provide your own tip text by passing tipText: -
- new Ext.slider.Single({
-     width: 214,
-     minValue: 0,
-     maxValue: 100,
-     useTips: true,
-     tipText: function(thumb){
-         return Ext.String.format('{0}% complete', thumb.value);
-     }
- });
- 
+ * + * @example + * Ext.create('Ext.slider.Single', { + * width: 214, + * minValue: 0, + * maxValue: 100, + * useTips: true, + * tipText: function(thumb){ + * return Ext.String.format('**{0}% complete**', thumb.value); + * }, + * renderTo: Ext.getBody() + * }); */ Ext.define('Ext.slider.Tip', { extend: 'Ext.tip.Tip', minWidth: 10, alias: 'widget.slidertip', offsets : [0, -10], - + isSliderTip: true, init: function(slider) { var me = this; - + slider.on({ scope : me, dragstart: me.onSlide, @@ -63,7 +61,7 @@ Ext.define('Ext.slider.Tip', { }, /** * @private - * Called whenever a dragstart or drag event is received on the associated Thumb. + * Called whenever a dragstart or drag event is received on the associated Thumb. * Aligns the Tip with the Thumb's new position. * @param {Ext.slider.MultiSlider} slider The slider * @param {Ext.EventObject} e The Event object @@ -78,8 +76,8 @@ Ext.define('Ext.slider.Tip', { }, /** - * Used to create the text that appears in the Tip's body. By default this just returns - * the value of the Slider Thumb that the Tip is attached to. Override to customize. + * Used to create the text that appears in the Tip's body. By default this just returns the value of the Slider + * Thumb that the Tip is attached to. Override to customize. * @param {Ext.slider.Thumb} thumb The Thumb that the Tip is attached to * @return {String} The text to display in the tip */