/FD3/FlashDevelop/Bin/Debug/Library/AS3/frameworks/FlashIDE/fl/controls/ProgressBar.as

https://bitbucket.org/kkszysiu/flashdevelop · ActionScript · 239 lines · 70 code · 4 blank · 165 comment · 0 complexity · c8ec4c08dca0aa8b7deefd17c78b67c0 MD5 · raw file 

    

  1. package fl.controls

    2. 

  2. {

    3. 

  3. 	import fl.controls.progressBarClasses.IndeterminateBar;

    4. 

  4. 	import fl.controls.ProgressBarDirection;

    5. 

  5. 	import fl.controls.ProgressBarMode;

    6. 

  6. 	import fl.core.InvalidationType;

    7. 

  7. 	import fl.core.UIComponent;

    8. 

  8. 	import flash.display.DisplayObject;

    9. 

  9. 	import flash.display.Sprite;

    10. 

  10. 	import flash.events.Event;

    11. 

  11. 	import flash.events.EventDispatcher;

    12. 

  12. 	import flash.events.ProgressEvent;

    13. 

  13. 

    14. 

  14. 	/**
    15. 

  15. 	 * Dispatched when the load operation completes. 
     *
     * @eventType flash.events.Event.COMPLETE
     *
     * @includeExample examples/ProgressBar.complete.1.as -noswf
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    16. 

  16. 	 */
    17. 

  17. 	[Event("complete", type="flash.events.Event")] 

    18. 

  18. 	/**
    19. 

  19. 	 * Dispatched as content loads in event mode or polled mode. 
     *
     * @eventType flash.events.ProgressEvent.PROGRESS
     *
     * @includeExample examples/ProgressBar.complete.1.as -noswf
     *
     * @see ProgressBarMode#EVENT ProgressBarMode.EVENT
     * @see ProgressBarMode#POLLED ProgressBarMode.POLLED
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    20. 

  20. 	 */
    21. 

  21. 	[Event("progress", type="flash.events.ProgressEvent")] 

    22. 

  22. 	/**
    23. 

  23. 	 * Name of the class to use as the default icon. Setting any other icon  
     * style overrides this setting.
     *  
     * @default null
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    24. 

  24. 	 */
    25. 

  25. 	[Style(name="icon", type="Class")] 

    26. 

  26. 	/**
    27. 

  27. 	 * Name of the class to use as the progress indicator track.
     * 
     * @default ProgressBar_trackSkin
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    28. 

  28. 	 */
    29. 

  29. 	[Style(name="trackSkin", type="Class")] 

    30. 

  30. 	/**
    31. 

  31. 	 * Name of the class to use as the determinate progress bar.
     * 
     * @default ProgressBar_barSkin
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    32. 

  32. 	 */
    33. 

  33. 	[Style(name="barSkin", type="Class")] 

    34. 

  34. 	/**
    35. 

  35. 	 * Name of the class to use as the indeterminate progress bar. This is passed to the  
     * indeterminate bar renderer, which is specified by the <code>indeterminateBar</code> 
     * style.
     *  
     * @default ProgressBar_indeterminateSkin
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    36. 

  36. 	 */
    37. 

  37. 	[Style(name="indeterminateSkin", type="Class")] 

    38. 

  38. 	/**
    39. 

  39. 	 * The class to use as a renderer for the indeterminate bar animation.  
     * This is an advanced style.
     * 
     * @default fl.controls.progressBarClasses.IndeterminateBar
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    40. 

  40. 	 */
    41. 

  41. 	[Style(name="indeterminateBar", type="Class")] 

    42. 

  42. 	/**
    43. 

  43. 	 * The padding that separates the progress bar indicator from the track, in pixels.
     * 
     * @default 0
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    44. 

  44. 	 */
    45. 

  45. 	[Style(name="barPadding", type="Number", format="Length")] 

    46. 

  46. 

    47. 

  47. 	/**
    48. 

  48. 	 * The ProgressBar component displays the progress of content that is 
	 * being loaded. The ProgressBar is typically used to display the status of 
	 * images, as well as portions of applications, while they are loading. 
	 * The loading process can be determinate or indeterminate. A determinate 
	 * progress bar is a linear representation of the progress of a task over 
	 * time and is used when the amount of content to load is known. An indeterminate 
     * progress bar has a striped fill and a loading source of unknown size.
	 *
     * @includeExample examples/ProgressBarExample.as
     *
     * @see ProgressBarDirection
     * @see ProgressBarMode
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    49. 

  49. 	 */
    50. 

  50. 	public class ProgressBar extends UIComponent

    51. 

  51. 	{

    52. 

  52. 		/**
    53. 

  53. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    54. 

  54. 		 */
    55. 

  55. 		protected var track : DisplayObject;

    56. 

  56. 		/**
    57. 

  57. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    58. 

  58. 		 */
    59. 

  59. 		protected var determinateBar : DisplayObject;

    60. 

  60. 		/**
    61. 

  61. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    62. 

  62. 		 */
    63. 

  63. 		protected var indeterminateBar : UIComponent;

    64. 

  64. 		/**
    65. 

  65. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    66. 

  66. 		 */
    67. 

  67. 		protected var _direction : String;

    68. 

  68. 		/**
    69. 

  69. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    70. 

  70. 		 */
    71. 

  71. 		protected var _indeterminate : Boolean;

    72. 

  72. 		/**
    73. 

  73. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    74. 

  74. 		 */
    75. 

  75. 		protected var _mode : String;

    76. 

  76. 		/**
    77. 

  77. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    78. 

  78. 		 */
    79. 

  79. 		protected var _minimum : Number;

    80. 

  80. 		/**
    81. 

  81. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    82. 

  82. 		 */
    83. 

  83. 		protected var _maximum : Number;

    84. 

  84. 		/**
    85. 

  85. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    86. 

  86. 		 */
    87. 

  87. 		protected var _value : Number;

    88. 

  88. 		/**
    89. 

  89. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    90. 

  90. 		 */
    91. 

  91. 		protected var _source : Object;

    92. 

  92. 		/**
    93. 

  93. 		 * @private (protected)
    94. 

  94. 		 */
    95. 

  95. 		protected var _loaded : Number;

    96. 

  96. 		/**
    97. 

  97. 		 * @private
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    98. 

  98. 		 */
    99. 

  99. 		private static var defaultStyles : Object;

    100. 

  100. 

    101. 

  101. 		/**
    102. 

  102. 		 * Indicates the fill direction for the progress bar. A value of 
         * <code>ProgressBarDirection.RIGHT</code> indicates that the progress 
         * bar is filled from left to right. A value of <code>ProgressBarDirection.LEFT</code>
         * indicates that the progress bar is filled from right to left.
         *
         * @default ProgressBarDirection.RIGHT
		 *
		 * @includeExample examples/ProgressBar.direction.1.as -noswf
		 *
         * @see ProgressBarDirection
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    103. 

  103. 		 */
    104. 

  104. 		public function get direction () : String;

    105. 

  105. 		/**
    106. 

  106. 		 * @private (setter)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    107. 

  107. 		 */
    108. 

  108. 		public function set direction (value:String) : void;

    109. 

  109. 		/**
    110. 

  110. 		 * Gets or sets a value that indicates the type of fill that the progress 
		 * bar uses and whether the loading source is known or unknown. A value of 
		 * <code>true</code> indicates that the progress bar has a striped fill 
		 * and a loading source of unknown size. A value of <code>false</code> 
		 * indicates that the progress bar has a solid fill and a loading source 
		 * of known size. 
		 *
		 * <p>This property can only be set when the progress bar mode 
		 * is set to <code>ProgressBarMode.MANUAL</code>.</p>
         *
         * @default true
		 *
		 * @see #mode
		 * @see ProgressBarMode
         * @see fl.controls.progressBarClasses.IndeterminateBar IndeterminateBar
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    111. 

  111. 		 */
    112. 

  112. 		public function get indeterminate () : Boolean;

    113. 

  113. 		/**
    114. 

  114. 		 * @private (setter)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    115. 

  115. 		 */
    116. 

  116. 		public function set indeterminate (value:Boolean) : void;

    117. 

  117. 		/**
    118. 

  118. 		 * Gets or sets the minimum value for the progress bar when the 
		 * <code>ProgressBar.mode</code> property is set to <code>ProgressBarMode.MANUAL</code>.
         *
         * @default 0
         *
         * @see #maximum
         * @see #percentComplete
         * @see #value
         * @see ProgressBarMode#MANUAL
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    119. 

  119. 		 */
    120. 

  120. 		public function get minimum () : Number;

    121. 

  121. 		/**
    122. 

  122. 		 * @private (setter)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    123. 

  123. 		 */
    124. 

  124. 		public function set minimum (value:Number) : void;

    125. 

  125. 		/**
    126. 

  126. 		 * Gets or sets the maximum value for the progress bar when the 
		 * <code>ProgressBar.mode</code> property is set to <code>ProgressBarMode.MANUAL</code>.
         *
         * @default 0
         *
         * @see #minimum
         * @see #percentComplete
         * @see #value
         * @see ProgressBarMode#MANUAL
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    127. 

  127. 		 */
    128. 

  128. 		public function get maximum () : Number;

    129. 

  129. 		/**
    130. 

  130. 		 * @private (setter)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    131. 

  131. 		 */
    132. 

  132. 		public function set maximum (value:Number) : void;

    133. 

  133. 		/**
    134. 

  134. 		 * Gets or sets a value that indicates the amount of progress that has 
		 * been made in the load operation. This value is a number between the 
		 * <code>minimum</code> and <code>maximum</code> values.
         *
         * @default 0
         *
         * @see #maximum
         * @see #minimum
         * @see #percentComplete
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    135. 

  135. 		 */
    136. 

  136. 		public function get value () : Number;

    137. 

  137. 		/**
    138. 

  138. 		 * @private (setter)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    139. 

  139. 		 */
    140. 

  140. 		public function set value (value:Number) : void;

    141. 

  141. 		/**
    142. 

  142. 		 * @private (internal)
    143. 

  143. 		 */
    144. 

  144. 		public function set sourceName (name:String) : void;

    145. 

  145. 		/**
    146. 

  146. 		 * Gets or sets a reference to the content that is being loaded and for
		 * which the ProgressBar is measuring the progress of the load operation. 
         * A typical usage of this property is to set it to a UILoader component.
		 *
		 * <p>Use this property only in event mode and polled mode.</p>
         *
         * @default null
		 *
         * @includeExample examples/ProgressBar.source.1.as -noswf
         * @includeExample examples/ProgressBar.source.2.as -noswf
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    147. 

  147. 		 */
    148. 

  148. 		public function get source () : Object;

    149. 

  149. 		/**
    150. 

  150. 		 * @private (setter)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    151. 

  151. 		 */
    152. 

  152. 		public function set source (value:Object) : void;

    153. 

  153. 		/**
    154. 

  154. 		 * Gets a number between 0 and 100 that indicates the percentage 
		 * of the content has already loaded. 
		 *
		 * <p>To change the percentage value, use the <code>setProgress()</code> method.</p>
         *
         * @default 0
         *
         * @includeExample examples/ProgressBar.percentComplete.1.as -noswf
         * @includeExample examples/ProgressBar.percentComplete.2.as -noswf
         *
         * @see #maximum
         * @see #minimum
         * @see #setProgress()
         * @see #value
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    155. 

  155. 		 */
    156. 

  156. 		public function get percentComplete () : Number;

    157. 

  157. 		/**
    158. 

  158. 		 * Gets or sets the method to be used to update the progress bar. 
		 *
		 * <p>The following values are valid for this property:</p> 
		 * <ul>
		 *     <li><code>ProgressBarMode.EVENT</code></li>
		 *     <li><code>ProgressBarMode.POLLED</code></li>
		 *     <li><code>ProgressBarMode.MANUAL</code></li>
		 * </ul>
         *
         * <p>Event mode and polled mode are the most common modes. In event mode, 
		 * the <code>source</code> property specifies loading content that generates  
		 * <code>progress</code> and <code>complete</code> events; you should use 
		 * a UILoader object in this mode. In polled mode, the <code>source</code> 
		 * property specifies loading content, such as a custom class, that exposes 
		 * <code>bytesLoaded</code> and <code>bytesTotal</code> properties. Any object 
		 * that exposes these properties can be used as a source in polled mode.</p>
         *
         * <p>You can also use the ProgressBar component in manual mode by manually 
         * setting the <code>maximum</code> and <code>minimum</code> properties and 
         * making calls to the <code>ProgressBar.setProgress()</code> method.</p>
         *
         * @default ProgressBarMode.EVENT
		 * 
         * @see ProgressBarMode
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    159. 

  159. 		 */
    160. 

  160. 		public function get mode () : String;

    161. 

  161. 		/**
    162. 

  162. 		 * @private (setter)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    163. 

  163. 		 */
    164. 

  164. 		public function set mode (value:String) : void;

    165. 

  165. 

    166. 

  166. 		/**
    167. 

  167. 		 * @copy fl.core.UIComponent#getStyleDefinition()
         *
		 * @includeExample ../core/examples/UIComponent.getStyleDefinition.1.as -noswf
		 *
         * @see fl.core.UIComponent#getStyle()
         * @see fl.core.UIComponent#setStyle()
         * @see fl.managers.StyleManager
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    168. 

  168. 		 */
    169. 

  169. 		public static function getStyleDefinition () : Object;

    170. 

  170. 		/**
    171. 

  171. 		 * Creates a new ProgressBar component instance.
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    172. 

  172. 		 */
    173. 

  173. 		public function ProgressBar ();

    174. 

  174. 		/**
    175. 

  175. 		 * Sets the state of the bar to reflect the amount of progress made when 
         * using manual mode. The <code>value</code> argument is assigned to the 
         * <code>value</code> property and the <code>maximum</code> argument is
         * assigned to the <code>maximum</code> property. The <code>minimum</code> 
         * property is not altered.
		 *
         * @param value A value describing the progress that has been made. 
		 *
         * @param maximum The maximum progress value of the progress bar.
		 *
         * @see #maximum
         * @see #value
         * @see ProgressBarMode#MANUAL ProgressBarMode.manual
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    176. 

  176. 		 */
    177. 

  177. 		public function setProgress (value:Number, maximum:Number) : void;

    178. 

  178. 		/**
    179. 

  179. 		 * Resets the progress bar for a new load operation.
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    180. 

  180. 		 */
    181. 

  181. 		public function reset () : void;

    182. 

  182. 		/**
    183. 

  183. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    184. 

  184. 		 */
    185. 

  185. 		protected function _setProgress (value:Number, maximum:Number, fireEvent:Boolean = false) : void;

    186. 

  186. 		/**
    187. 

  187. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    188. 

  188. 		 */
    189. 

  189. 		protected function setIndeterminate (value:Boolean) : void;

    190. 

  190. 		/**
    191. 

  191. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    192. 

  192. 		 */
    193. 

  193. 		protected function resetProgress () : void;

    194. 

  194. 		/**
    195. 

  195. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    196. 

  196. 		 */
    197. 

  197. 		protected function setupSourceEvents () : void;

    198. 

  198. 		/**
    199. 

  199. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    200. 

  200. 		 */
    201. 

  201. 		protected function cleanupSourceEvents () : void;

    202. 

  202. 		/**
    203. 

  203. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    204. 

  204. 		 */
    205. 

  205. 		protected function pollSource (event:Event) : void;

    206. 

  206. 		/**
    207. 

  207. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    208. 

  208. 		 */
    209. 

  209. 		protected function handleProgress (event:ProgressEvent) : void;

    210. 

  210. 		/**
    211. 

  211. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    212. 

  212. 		 */
    213. 

  213. 		protected function handleComplete (event:Event) : void;

    214. 

  214. 		/**
    215. 

  215. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    216. 

  216. 		 */
    217. 

  217. 		protected function draw () : void;

    218. 

  218. 		/**
    219. 

  219. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    220. 

  220. 		 */
    221. 

  221. 		protected function drawTrack () : void;

    222. 

  222. 		/**
    223. 

  223. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    224. 

  224. 		 */
    225. 

  225. 		protected function drawBars () : void;

    226. 

  226. 		/**
    227. 

  227. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    228. 

  228. 		 */
    229. 

  229. 		protected function drawDeterminateBar () : void;

    230. 

  230. 		/**
    231. 

  231. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    232. 

  232. 		 */
    233. 

  233. 		protected function drawLayout () : void;

    234. 

  234. 		/**
    235. 

  235. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    236. 

  236. 		 */
    237. 

  237. 		protected function configUI () : void;

    238. 

  238. 	}

    239. 

  239. }
    240.