/FD3/FlashDevelop/Bin/Debug/Library/AS3/frameworks/FlashIDE/fl/containers/ScrollPane.as

https://bitbucket.org/kkszysiu/flashdevelop · ActionScript · 251 lines · 82 code · 4 blank · 165 comment · 0 complexity · 0d5450248bb15c97e977fb7865469c0c MD5 · raw file 

    

  1. package fl.containers

    2. 

  2. {

    3. 

  3. 	import fl.containers.BaseScrollPane;

    4. 

  4. 	import fl.controls.ScrollBar;

    5. 

  5. 	import fl.controls.ScrollPolicy;

    6. 

  6. 	import fl.core.InvalidationType;

    7. 

  7. 	import fl.core.UIComponent;

    8. 

  8. 	import fl.events.ScrollEvent;

    9. 

  9. 	import fl.managers.IFocusManagerComponent;

    10. 

  10. 	import flash.display.DisplayObject;

    11. 

  11. 	import flash.display.Loader;

    12. 

  12. 	import flash.display.Sprite;

    13. 

  13. 	import flash.events.Event;

    14. 

  14. 	import flash.events.KeyboardEvent;

    15. 

  15. 	import flash.events.MouseEvent;

    16. 

  16. 	import flash.events.ProgressEvent;

    17. 

  17. 	import flash.events.SecurityErrorEvent;

    18. 

  18. 	import flash.events.IOErrorEvent;

    19. 

  19. 	import flash.events.HTTPStatusEvent;

    20. 

  20. 	import flash.geom.Rectangle;

    21. 

  21. 	import flash.net.URLRequest;

    22. 

  22. 	import flash.system.ApplicationDomain;

    23. 

  23. 	import flash.system.LoaderContext;

    24. 

  24. 	import flash.ui.Keyboard;

    25. 

  25. 

    26. 

  26. 	/**
    27. 

  27. 	 * @copy BaseScrollPane#event:scroll
     *
     * @includeExample examples/ScrollPane.scroll.1.as -noswf
     *
     * @eventType fl.events.ScrollEvent.SCROLL
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    28. 

  28. 	 */
    29. 

  29. 	[Event(name="scroll", type="fl.events.ScrollEvent")] 

    30. 

  30. 	/**
    31. 

  31. 	 * Dispatched while content is loading.
     *
     * @eventType flash.events.ProgressEvent.PROGRESS
     *
     * @includeExample examples/ScrollPane.percentLoaded.1.as -noswf
     *
     * @see #event:complete
     * @see #bytesLoaded
     * @see #bytesTotal
     * @see #percentLoaded
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    32. 

  32. 	 */
    33. 

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

    34. 

  34. 	/**
    35. 

  35. 	 * Dispatched when content has finished loading.
     *
     * @includeExample examples/ScrollPane.complete.1.as -noswf
     *
     * @eventType flash.events.Event.COMPLETE
     * 
     * @see #event:progress
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    36. 

  36. 	 */
    37. 

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

    38. 

  38. 	/**
    39. 

  39. 	 * Dispatched when the properties and methods of a loaded SWF file are accessible. 
     * The following conditions must exist for this event to be dispatched: 
     * <ul>
     *     <li>All the properties and methods that are associated with the loaded object,
	 *         as well as those that are associated with the component, must be accessible.</li>
     *     <li>The constructors for all child objects must have completed.</li>
     * </ul>
     *
     * @eventType flash.events.Event.INIT
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    40. 

  40. 	 */
    41. 

  41. 	[Event("init", type="flash.events.Event")] 

    42. 

  42. 	/**
    43. 

  43. 	 * Dispatched after an input or output error occurs.
     *
     * @includeExample examples/UILoader.ioError.1.as -noswf
     *
     * @eventType flash.events.IOErrorEvent.IO_ERROR
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    44. 

  44. 	 */
    45. 

  45. 	[Event("ioError", type="flash.events.IOErrorEvent")] 

    46. 

  46. 	/**
    47. 

  47. 	 * Dispatched after a network operation starts.
     *
     * @eventType flash.events.Event.OPEN
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    48. 

  48. 	 */
    49. 

  49. 	[Event("open", type="flash.events.Event")] 

    50. 

  50. 	/**
    51. 

  51. 	 * Dispatched after a security error occurs while content is loading.
     *
     * @eventType flash.events.SecurityErrorEvent.SECURITY_ERROR
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    52. 

  52. 	 */
    53. 

  53. 	[Event("securityError", type="flash.events.SecurityErrorEvent")] 

    54. 

  54. 	/**
    55. 

  55. 	 * Dispatched when content is loading. This event is dispatched regardless of
     * whether the load operation was triggered by an auto-load process or an explicit call to the 
     * <code>load()</code> method.
     *
     * @includeExample examples/UILoader.progress.1.as -noswf
     * 
	 * @eventType flash.events.ProgressEvent.PROGRESS
     *
     * @see #event:complete
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    56. 

  56. 	 */
    57. 

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

    58. 

  58. 	/**
    59. 

  59. 	 * The skin that shows when the scroll pane is disabled.
     *
     * @default ScrollPane_disabledSkin
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    60. 

  60. 	 */
    61. 

  61. 	[Style(name="disabledSkin", type="Class")] 

    62. 

  62. 	/**
    63. 

  63. 	 * The default skin shown on the scroll pane.
     *
     * @default ScrollPane_upSkin
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    64. 

  64. 	 */
    65. 

  65. 	[Style(name="upSkin", type="Class")] 

    66. 

  66. 	/**
    67. 

  67. 	 * The amount of padding to put around the content in the scroll pane, in pixels.
     *
     * @default 0
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    68. 

  68. 	 */
    69. 

  69. 	[Style(name="contentPadding", type="Number", format="Length")] 

    70. 

  70. 

    71. 

  71. 	/**
    72. 

  72. 	 * The ScrollPane component displays display objects and JPEG, GIF, and PNG files,
     * as well as SWF files, in a scrollable area. You can use a scroll pane to 
     * limit the screen area that is occupied by these media types.
     * The scroll pane can display content that is loaded from a local
     * disk or from the Internet. You can set this content while
     * authoring and, at run time, by using ActionScript. After the scroll
     * pane has focus, if its content has valid tab stops, those
     * markers receive focus. After the last tab stop in the content,
     * focus moves to the next component. The vertical and horizontal
     * scroll bars in the scroll pane do not receive focus.
	 *
	 * <p><strong>Note:</strong> When content is being loaded from a different 
	 * domain or <em>sandbox</em>, the properties of the content may be inaccessible 
	 * for security reasons. For more information about how domain security 
	 * affects the load process, see the Loader class.</p>
	 *
	 * <p><strong>Note:</strong> When loading very large image files into a ScrollPane object,
	 * it may be necessary to listen for the <code>complete</code> event and then resize the
	 * ScrollPane using the <code>setSize()</code> method. See the <code>complete</code>
	 * event example.</p>
	 *
	 * @see flash.display.Loader Loader
	 *
     * @includeExample examples/ScrollPaneExample.as -noswf
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    73. 

  73. 	 */
    74. 

  74. 	public class ScrollPane extends BaseScrollPane implements IFocusManagerComponent

    75. 

  75. 	{

    76. 

  76. 		/**
    77. 

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

  78. 		 */
    79. 

  79. 		protected var _source : Object;

    80. 

  80. 		/**
    81. 

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

  82. 		 */
    83. 

  83. 		protected var _scrollDrag : Boolean;

    84. 

  84. 		/**
    85. 

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

  86. 		 */
    87. 

  87. 		protected var contentClip : Sprite;

    88. 

  88. 		/**
    89. 

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

  90. 		 */
    91. 

  91. 		protected var loader : Loader;

    92. 

  92. 		/**
    93. 

  93. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    94. 

  94. 		 */
    95. 

  95. 		protected var xOffset : Number;

    96. 

  96. 		/**
    97. 

  97. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    98. 

  98. 		 */
    99. 

  99. 		protected var yOffset : Number;

    100. 

  100. 		/**
    101. 

  101. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    102. 

  102. 		 */
    103. 

  103. 		protected var scrollDragHPos : Number;

    104. 

  104. 		/**
    105. 

  105. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    106. 

  106. 		 */
    107. 

  107. 		protected var scrollDragVPos : Number;

    108. 

  108. 		/**
    109. 

  109. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    110. 

  110. 		 */
    111. 

  111. 		protected var currentContent : Object;

    112. 

  112. 		/**
    113. 

  113. 		 * @private
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    114. 

  114. 		 */
    115. 

  115. 		private static var defaultStyles : Object;

    116. 

  116. 

    117. 

  117. 		/**
    118. 

  118. 		 * Gets or sets a value that indicates whether scrolling occurs when a
         * user drags on content within the scroll pane. A value of <code>true</code>
         * indicates that scrolling occurs when a user drags on the content; a value
         * of <code>false</code> indicates that it does not.
         *
         * @default false
         *
         * @includeExample examples/ScrollPane.scrollDrag.1.as -noswf
         *
         * @see #event:scroll
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    119. 

  119. 		 */
    120. 

  120. 		public function get scrollDrag () : Boolean;

    121. 

  121. 		/**
    122. 

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

  123. 		 */
    124. 

  124. 		public function set scrollDrag (value:Boolean) : void;

    125. 

  125. 		/**
    126. 

  126. 		 * Gets a number between 0 and 100 indicating what percentage of the content is loaded.
         * If you are loading assets from your library, and not externally loaded content, 
         * the <code>percentLoaded</code> property is set to 0.
         *
         * @default 0
         *
         * @includeExample examples/ScrollPane.percentLoaded.1.as -noswf
         *
         * @see #bytesLoaded
         * @see #bytesTotal
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    127. 

  127. 		 */
    128. 

  128. 		public function get percentLoaded () : Number;

    129. 

  129. 		/**
    130. 

  130. 		 * Gets the count of bytes of content that have been loaded.
         * When this property equals the value of <code>bytesTotal</code>,
         * all the bytes are loaded.  
         *
         * @default 0
         *
         * @see #bytesTotal
         * @see #percentLoaded
         *
         * @includeExample examples/ScrollPane.bytesLoaded.1.as -noswf
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    131. 

  131. 		 */
    132. 

  132. 		public function get bytesLoaded () : Number;

    133. 

  133. 		/**
    134. 

  134. 		 * Gets the count of bytes of content to be loaded.
         *
         * @default 0
         *
         * @includeExample examples/ScrollPane.percentLoaded.1.as -noswf
         *
         * @see #bytesLoaded
         * @see #percentLoaded
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    135. 

  135. 		 */
    136. 

  136. 		public function get bytesTotal () : Number;

    137. 

  137. 		/**
    138. 

  138. 		 * Gets a reference to the content loaded into the scroll pane.
         *
         * @default null
         *
         * @includeExample examples/ScrollPane.content.1.as -noswf
         * @includeExample examples/ScrollPane.content.2.as -noswf
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    139. 

  139. 		 */
    140. 

  140. 		public function get content () : DisplayObject;

    141. 

  141. 		/**
    142. 

  142. 		 * Gets or sets an absolute or relative URL that identifies the 
		 * location of the SWF or image file to load, the class name 
		 * of a movie clip in the library, a reference to a display object,
		 * or a instance name of a movie clip on the same level as the component.
		 * 
		 * <p>Valid image file formats include GIF, PNG, and JPEG. To load an 
		 * asset by using a URLRequest object, use the <code>load()</code> 
		 * method.</p>
         *
         * @default null
         *
         * @includeExample examples/ScrollPane.source.1.as -noswf
         * @includeExample examples/ScrollPane.source.2.as -noswf
         *
         * @see #load()
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    143. 

  143. 		 */
    144. 

  144. 		public function get source () : Object;

    145. 

  145. 		/**
    146. 

  146. 		 * @private (setter)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    147. 

  147. 		 */
    148. 

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

    149. 

  149. 

    150. 

  150. 		/**
    151. 

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

  152. 		 */
    153. 

  153. 		public static function getStyleDefinition () : Object;

    154. 

  154. 		/**
    155. 

  155. 		 * Creates a new ScrollPane component instance.
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    156. 

  156. 		 */
    157. 

  157. 		public function ScrollPane ();

    158. 

  158. 		/**
    159. 

  159. 		 * Reloads the contents of the scroll pane. 
         *
         * <p> This method does not redraw the scroll bar. To reset the 
         * scroll bar, use the <code>update()</code> method.</p>
         *
         * @includeExample examples/ScrollPane.refreshPane.1.as -noswf
         *
         * @see #update()
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    160. 

  160. 		 */
    161. 

  161. 		public function refreshPane () : void;

    162. 

  162. 		/**
    163. 

  163. 		 * Refreshes the scroll bar properties based on the width
         * and height of the content.  This is useful if the content
         * of the ScrollPane changes during run time.
         *
         * @includeExample examples/ScrollPane.update.1.as -noswf
         *
         * @see #refreshPane()
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    164. 

  164. 		 */
    165. 

  165. 		public function update () : void;

    166. 

  166. 		/**
    167. 

  167. 		 * The request parameter of this method accepts only a URLRequest object 
		 * whose <code>source</code> property contains a string, a class, or a 
		 * URLRequest object.
		 * 
		 * By default, the LoaderContext object uses the current domain as the 
		 * application domain. To specify a different application domain value, 
		 * to check a policy file, or to change the security domain, initialize 
		 * a new LoaderContext object and pass it to this method.
		 *
		 * @param request The URLRequest object to use to load an image into the scroll pane.
		 * @param context The LoaderContext object that sets the context of the load operation.
		 *
         * @see #source
         * @see fl.containers.UILoader#load() UILoader.load()
         * @see flash.net.URLRequest
         * @see flash.system.ApplicationDomain
         * @see flash.system.LoaderContext
         *
         * @includeExample examples/ScrollPane.load.1.as -noswf
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    168. 

  168. 		 */
    169. 

  169. 		public function load (request:URLRequest, context:LoaderContext = null) : void;

    170. 

  170. 		/**
    171. 

  171. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    172. 

  172. 		 */
    173. 

  173. 		protected function setVerticalScrollPosition (scrollPos:Number, fireEvent:Boolean = false) : void;

    174. 

  174. 		/**
    175. 

  175. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    176. 

  176. 		 */
    177. 

  177. 		protected function setHorizontalScrollPosition (scrollPos:Number, fireEvent:Boolean = false) : void;

    178. 

  178. 		/**
    179. 

  179. 		 * @private (protected)
    180. 

  180. 		 */
    181. 

  181. 		protected function drawLayout () : void;

    182. 

  182. 		/**
    183. 

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

  184. 		 */
    185. 

  185. 		protected function onContentLoad (event:Event) : void;

    186. 

  186. 		/**
    187. 

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

  188. 		 */
    189. 

  189. 		protected function passEvent (event:Event) : void;

    190. 

  190. 		/**
    191. 

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

  192. 		 */
    193. 

  193. 		protected function initLoader () : void;

    194. 

  194. 		/**
    195. 

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

  196. 		 */
    197. 

  197. 		protected function handleScroll (event:ScrollEvent) : void;

    198. 

  198. 		/**
    199. 

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

  200. 		 */
    201. 

  201. 		protected function handleError (event:Event) : void;

    202. 

  202. 		/**
    203. 

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

  204. 		 */
    205. 

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

    206. 

  206. 		/**
    207. 

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

  208. 		 */
    209. 

  209. 		protected function clearLoadEvents () : void;

    210. 

  210. 		/**
    211. 

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

  212. 		 */
    213. 

  213. 		protected function doDrag (event:MouseEvent) : void;

    214. 

  214. 		/**
    215. 

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

  216. 		 */
    217. 

  217. 		protected function doStartDrag (event:MouseEvent) : void;

    218. 

  218. 		/**
    219. 

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

  220. 		 */
    221. 

  221. 		protected function endDrag (event:MouseEvent) : void;

    222. 

  222. 		/**
    223. 

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

  224. 		 */
    225. 

  225. 		protected function setScrollDrag () : void;

    226. 

  226. 		/**
    227. 

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

  228. 		 */
    229. 

  229. 		protected function draw () : void;

    230. 

  230. 		/**
    231. 

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

  232. 		 */
    233. 

  233. 		protected function drawBackground () : void;

    234. 

  234. 		/**
    235. 

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

  236. 		 */
    237. 

  237. 		protected function clearContent () : void;

    238. 

  238. 		/**
    239. 

  239. 		 * @private
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    240. 

  240. 		 */
    241. 

  241. 		protected function keyDownHandler (event:KeyboardEvent) : void;

    242. 

  242. 		/**
    243. 

  243. 		 * @private
    244. 

  244. 		 */
    245. 

  245. 		protected function calculateAvailableHeight () : Number;

    246. 

  246. 		/**
    247. 

  247. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    248. 

  248. 		 */
    249. 

  249. 		protected function configUI () : void;

    250. 

  250. 	}

    251. 

  251. }
    252.