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

https://bitbucket.org/kkszysiu/flashdevelop · ActionScript · 406 lines · 120 code · 4 blank · 282 comment · 0 complexity · 2ab7a13471f2c0caade09567ee41a236 MD5 · raw file 

    

  1. package fl.controls

    2. 

  2. {

    3. 

  3. 	import fl.containers.BaseScrollPane;

    4. 

  4. 	import fl.controls.listClasses.CellRenderer;

    5. 

  5. 	import fl.controls.listClasses.ICellRenderer;

    6. 

  6. 	import fl.controls.listClasses.ListData;

    7. 

  7. 	import fl.controls.ScrollPolicy;

    8. 

  8. 	import fl.core.InvalidationType;

    9. 

  9. 	import fl.core.UIComponent;

    10. 

  10. 	import fl.data.DataProvider;

    11. 

  11. 	import fl.data.SimpleCollectionItem;

    12. 

  12. 	import fl.events.DataChangeEvent;

    13. 

  13. 	import fl.events.DataChangeType;

    14. 

  14. 	import fl.events.ListEvent;

    15. 

  15. 	import fl.events.ScrollEvent;

    16. 

  16. 	import fl.managers.IFocusManagerComponent;

    17. 

  17. 	import flash.display.DisplayObject;

    18. 

  18. 	import flash.display.Sprite;

    19. 

  19. 	import flash.events.Event;

    20. 

  20. 	import flash.events.KeyboardEvent;

    21. 

  21. 	import flash.events.MouseEvent;

    22. 

  22. 	import flash.ui.Keyboard;

    23. 

  23. 	import flash.utils.Dictionary;

    24. 

  24. 

    25. 

  25. 	/**
    26. 

  26. 	 * Dispatched when the user rolls the pointer off of an item in the component.
     *
	 * @eventType fl.events.ListEvent.ITEM_ROLL_OUT
     *
     * @see #event:itemRollOver
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    27. 

  27. 	 */
    28. 

  28. 	[Event(name="itemRollOut", type="fl.events.ListEvent")] 

    29. 

  29. 	/**
    30. 

  30. 	 * Dispatched when the user rolls the pointer over an item in the component.
     *
     * @eventType fl.events.ListEvent.ITEM_ROLL_OVER
     *
     * @see #event:itemRollOut
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    31. 

  31. 	 */
    32. 

  32. 	[Event(name="itemRollOver", type="fl.events.ListEvent")] 

    33. 

  33. 	/**
    34. 

  34. 	 * Dispatched when the user rolls the pointer over the component.
	 * 
	 * @eventType flash.events.MouseEvent.ROLL_OVER
     *
     * @see #event:rollOut
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    35. 

  35. 	 */
    36. 

  36. 	[Event(name="rollOver", type="flash.events.MouseEvent")] 

    37. 

  37. 	/**
    38. 

  38. 	 * Dispatched when the user rolls the pointer off of the component.
     *
	 * @eventType flash.events.MouseEvent.ROLL_OUT
     *
     * @see #event:rollOver
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    39. 

  39. 	 */
    40. 

  40. 	[Event(name="rollOut", type="flash.events.MouseEvent")] 

    41. 

  41. 	/**
    42. 

  42. 	 * Dispatched when the user clicks an item in the component. 
	 *
	 * <p>The <code>click</code> event is dispatched before the value
	 * of the component is changed. To identify the row and column that were clicked,
	 * use the properties of the event object; do not use the <code>selectedIndex</code> 
     * and <code>selectedItem</code> properties.</p>
     *
     * @eventType fl.events.ListEvent.ITEM_CLICK
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    43. 

  43. 	 */
    44. 

  44. 	[Event(name="itemClick", type="fl.events.ListEvent")] 

    45. 

  45. 	/**
    46. 

  46. 	 * Dispatched when the user clicks an item in the component twice in
     * rapid succession. Unlike the <code>click</code> event, the doubleClick event is 
	 * dispatched after the <code>selectedIndex</code> of the component is 
	 * changed.
     *
     * @eventType fl.events.ListEvent.ITEM_DOUBLE_CLICK
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    47. 

  47. 	 */
    48. 

  48. 	[Event(name="itemDoubleClick", type="fl.events.ListEvent")] 

    49. 

  49. 	/**
    50. 

  50. 	 * Dispatched when a different item is selected in the list.
     *
     * @eventType flash.events.Event.CHANGE
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    51. 

  51. 	 */
    52. 

  52. 	[Event(name="change", type="flash.events.Event")] 

    53. 

  53. 	/**
    54. 

  54. 	 * Dispatched when the user scrolls horizontally or vertically.
     *
     * @eventType fl.events.ScrollEvent.SCROLL
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    55. 

  55. 	 */
    56. 

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

    57. 

  57. 	/**
    58. 

  58. 	 * The class that provides the skin for the background of the component.
     *
     * @default List_skin
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    59. 

  59. 	 */
    60. 

  60. 	[Style(name="skin", type="Class")] 

    61. 

  61. 	/**
    62. 

  62. 	 * The class that provides the cell renderer for each item in the component.
     *
     * @default fl.contols.listClasses.CellRenderer
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    63. 

  63. 	 */
    64. 

  64. 	[Style(name="cellRenderer", type="Class")] 

    65. 

  65. 	/**
    66. 

  66. 	 * The alpha value to set the list to when the <code>enabled</code> property is <code>false</code>.
     *
     * @default null
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    67. 

  67. 	 */
    68. 

  68. 	[Style(name="disabledAlpha", type="Number")] 

    69. 

  69. 	/**
    70. 

  70. 	 * The padding that separates the border of the list from its contents, in pixels.
     *
     * @default null
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    71. 

  71. 	 */
    72. 

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

    73. 

  73. 

    74. 

  74. 	/**
    75. 

  75. 	 * The SelectableList is the base class for all list-based components--for  
	 * example, the List, TileList, DataGrid, and ComboBox components. 
	 * This class provides methods and properties that are used for the 
	 * rendering and layout of rows, and to set scroll bar styles and data
	 * providers. 
     *
     * <p><strong>Note:</strong> This class does not create a component; 
	 * it is exposed only so that it can be extended.</p>
	 * 
	 * @see fl.controls.DataGrid
	 * @see fl.controls.List 
	 * @see fl.controls.TileList
     * @see fl.data.DataProvider
     *
     * @langversion 3.0
     * @playerversion Flash 9.0.28.0
    76. 

  76. 	 */
    77. 

  77. 	public class SelectableList extends BaseScrollPane implements IFocusManagerComponent

    78. 

  78. 	{

    79. 

  79. 		/**
    80. 

  80. 		 * @private
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    81. 

  81. 		 */
    82. 

  82. 		protected var listHolder : Sprite;

    83. 

  83. 		/**
    84. 

  84. 		 * @private
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    85. 

  85. 		 */
    86. 

  86. 		protected var list : Sprite;

    87. 

  87. 		/**
    88. 

  88. 		 * @private
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    89. 

  89. 		 */
    90. 

  90. 		protected var _dataProvider : DataProvider;

    91. 

  91. 		/**
    92. 

  92. 		 * @private
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    93. 

  93. 		 */
    94. 

  94. 		protected var activeCellRenderers : Array;

    95. 

  95. 		/**
    96. 

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

  97. 		 */
    98. 

  98. 		protected var availableCellRenderers : Array;

    99. 

  99. 		/**
    100. 

  100. 		 * @private
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    101. 

  101. 		 */
    102. 

  102. 		protected var renderedItems : Dictionary;

    103. 

  103. 		/**
    104. 

  104. 		 * @private
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    105. 

  105. 		 */
    106. 

  106. 		protected var invalidItems : Dictionary;

    107. 

  107. 		/**
    108. 

  108. 		 * @private
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    109. 

  109. 		 */
    110. 

  110. 		protected var _horizontalScrollPosition : Number;

    111. 

  111. 		/**
    112. 

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

  113. 		 */
    114. 

  114. 		protected var _verticalScrollPosition : Number;

    115. 

  115. 		/**
    116. 

  116. 		 * @private
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    117. 

  117. 		 */
    118. 

  118. 		protected var _allowMultipleSelection : Boolean;

    119. 

  119. 		/**
    120. 

  120. 		 * @private
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    121. 

  121. 		 */
    122. 

  122. 		protected var _selectable : Boolean;

    123. 

  123. 		/**
    124. 

  124. 		 * @private
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    125. 

  125. 		 */
    126. 

  126. 		protected var _selectedIndices : Array;

    127. 

  127. 		/**
    128. 

  128. 		 * @private
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    129. 

  129. 		 */
    130. 

  130. 		protected var caretIndex : int;

    131. 

  131. 		/**
    132. 

  132. 		 * @private
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    133. 

  133. 		 */
    134. 

  134. 		protected var lastCaretIndex : int;

    135. 

  135. 		/**
    136. 

  136. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    137. 

  137. 		 */
    138. 

  138. 		protected var preChangeItems : Array;

    139. 

  139. 		/**
    140. 

  140. 		 * @private
    141. 

  141. 		 */
    142. 

  142. 		private var collectionItemImport : SimpleCollectionItem;

    143. 

  143. 		/**
    144. 

  144. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    145. 

  145. 		 */
    146. 

  146. 		protected var rendererStyles : Object;

    147. 

  147. 		/**
    148. 

  148. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    149. 

  149. 		 */
    150. 

  150. 		protected var updatedRendererStyles : Object;

    151. 

  151. 		/**
    152. 

  152. 		 * @private
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    153. 

  153. 		 */
    154. 

  154. 		private static var defaultStyles : Object;

    155. 

  155. 		/**
    156. 

  156. 		 *  @private
		 *  Creates the Accessibility class.
         *  This method is called from UIComponent.
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    157. 

  157. 		 */
    158. 

  158. 		public static var createAccessibilityImplementation : Function;

    159. 

  159. 

    160. 

  160. 		/**
    161. 

  161. 		 * @private
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    162. 

  162. 		 */
    163. 

  163. 		public function set enabled (value:Boolean) : void;

    164. 

  164. 		/**
    165. 

  165. 		 * Gets or sets the data model of the list of items to be viewed. A data provider 
		 * can be shared by multiple list-based components. Changes to the data provider 
		 * are immediately available to all components that use it as a data source. 
		 *  
		 * @default null
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    166. 

  166. 		 */
    167. 

  167. 		public function get dataProvider () : DataProvider;

    168. 

  168. 		/**
    169. 

  169. 		 * @private (setter)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    170. 

  170. 		 */
    171. 

  171. 		public function set dataProvider (value:DataProvider) : void;

    172. 

  172. 		/**
    173. 

  173. 		 * Gets or sets the number of pixels that the list scrolls to the right when the
         * <code>horizontalScrollPolicy</code> property is set to <code>ScrollPolicy.ON</code>.
         *
         * @see fl.containers.BaseScrollPane#horizontalScrollPosition
         * @see fl.containers.BaseScrollPane#maxVerticalScrollPosition
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    174. 

  174. 		 */
    175. 

  175. 		public function get maxHorizontalScrollPosition () : Number;

    176. 

  176. 		/**
    177. 

  177. 		 * @private
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    178. 

  178. 		 */
    179. 

  179. 		public function set maxHorizontalScrollPosition (value:Number) : void;

    180. 

  180. 		/**
    181. 

  181. 		 * Gets the number of items in the data provider.
         *
         * @includeExample examples/SelectableList.length.1.as -noswf
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    182. 

  182. 		 */
    183. 

  183. 		public function get length () : uint;

    184. 

  184. 		/**
    185. 

  185. 		 * Gets a Boolean value that indicates whether more than one list item 
		 * can be selected at a time. A value of <code>true</code> indicates that 
		 * multiple selections can be made at one time; a value of <code>false</code> 
		 * indicates that only one item can be selected at one time. 
         *
         * @default false
         *
         * @includeExample examples/List.allowMultipleSelection.1.as -noswf
         *
         * @see #selectable
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    186. 

  186. 		 */
    187. 

  187. 		public function get allowMultipleSelection () : Boolean;

    188. 

  188. 		/**
    189. 

  189. 		 * @private
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    190. 

  190. 		 */
    191. 

  191. 		public function set allowMultipleSelection (value:Boolean) : void;

    192. 

  192. 		/**
    193. 

  193. 		 * Gets or sets a Boolean value that indicates whether the items in the list 
		 * can be selected. A value of <code>true</code> indicates that the list items
		 * can be selected; a value of <code>false</code> indicates that they cannot be. 
 		 * 
         * @default true
         *
         * @see #allowMultipleSelection
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    194. 

  194. 		 */
    195. 

  195. 		public function get selectable () : Boolean;

    196. 

  196. 		/**
    197. 

  197. 		 * @private
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    198. 

  198. 		 */
    199. 

  199. 		public function set selectable (value:Boolean) : void;

    200. 

  200. 		/**
    201. 

  201. 		 * Gets or sets the index of the item that is selected in a single-selection
		 * list. A single-selection list is a list in which only one item can be selected 
		 * at a time. 
		 *
		 * <p>A value of -1 indicates that no item is selected; if multiple selections
		 * are made, this value is equal to the index of the item that was selected last in
		 * the group of selected items.</p>
		 *
		 * <p>When ActionScript is used to set this property, the item at the specified index
		 * replaces the current selection. When the selection is changed programmatically, 
		 * a <code>change</code> event object is not dispatched. </p>
         *
         * @see #selectedIndices
         * @see #selectedItem
		 *
		 * @includeExample examples/SelectableList.selectedIndex.1.as -noswf
		 *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    202. 

  202. 		 */
    203. 

  203. 		public function get selectedIndex () : int;

    204. 

  204. 		/**
    205. 

  205. 		 * @private
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    206. 

  206. 		 */
    207. 

  207. 		public function set selectedIndex (value:int) : void;

    208. 

  208. 		/**
    209. 

  209. 		 * Gets or sets an array that contains the items that were selected from
		 * a multiple-selection list. 
		 *
		 * <p>To replace the current selection programmatically, you can make an 
		 * explicit assignment to this property. You can clear the current selection 
		 * by setting this property to an empty array or to a value of <code>undefined</code>. 
		 * If no items are selected from the list of items, this property is 
		 * <code>undefined</code>. </p>
		 *
		 * <p>The sequence of values in the array reflects the order in which the items
		 * were selected from the multiple-selection list. For example, if you click the second 
		 * item from the list, then the third item, and finally the first item, this property 
		 * contains an array of values in the following sequence: <code>[1,2,0]</code>.</p>
         *
         * @see #allowMultipleSelection
         * @see #selectedIndex
         * @see #selectedItems
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    210. 

  210. 		 */
    211. 

  211. 		public function get selectedIndices () : Array;

    212. 

  212. 		/**
    213. 

  213. 		 * @private
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    214. 

  214. 		 */
    215. 

  215. 		public function set selectedIndices (value:Array) : void;

    216. 

  216. 		/**
    217. 

  217. 		 * Gets or sets the item that was selected from a single-selection list. For a 
		 * multiple-selection list in which multiple items are selected, this property
		 * contains the item that was selected last. 
		 *
		 * <p>If no selection is made, the value of this property is <code>null</code>.</p>
         *
         * @see #selectedIndex
         * @see #selectedItems
		 *
		 * @includeExample examples/SelectableList.selectedIndex.1.as -noswf
		 *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    218. 

  218. 		 */
    219. 

  219. 		public function get selectedItem () : Object;

    220. 

  220. 		/**
    221. 

  221. 		 * @private (setter)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    222. 

  222. 		 */
    223. 

  223. 		public function set selectedItem (value:Object) : void;

    224. 

  224. 		/**
    225. 

  225. 		 * Gets or sets an array that contains the objects for the  
		 * items that were selected from the multiple-selection list. 
		 *
		 * <p>For a single-selection list, the value of this property is an 
		 * array containing the one selected item. In a single-selection 
		 * list, the <code>allowMultipleSelection</code> property is set to 
		 * <code>false</code>.</p>
         *
         * @includeExample examples/SelectableList.selectedItems.1.as -noswf
         *
         * @see #allowMultipleSelection
         * @see #selectedIndices
         * @see #selectedItem
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    226. 

  226. 		 */
    227. 

  227. 		public function get selectedItems () : Array;

    228. 

  228. 		/**
    229. 

  229. 		 * @private (setter)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    230. 

  230. 		 */
    231. 

  231. 		public function set selectedItems (value:Array) : void;

    232. 

  232. 		/**
    233. 

  233. 		 * Gets the number of rows that are at least partially visible in the list.
		 * 
         * <p><strong>Note:</strong> This property must be overridden in any class that extends SelectableList.</p>
         *
		 * @includeExample examples/SelectableList.rowCount.1.as -noswf
		 *
		 * @default 0
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    234. 

  234. 		 */
    235. 

  235. 		public function get rowCount () : uint;

    236. 

  236. 

    237. 

  237. 		/**
    238. 

  238. 		 * @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
    239. 

  239. 		 */
    240. 

  240. 		public static function getStyleDefinition () : Object;

    241. 

  241. 		/**
    242. 

  242. 		 * Creates a new SelectableList instance.
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    243. 

  243. 		 */
    244. 

  244. 		public function SelectableList ();

    245. 

  245. 		/**
    246. 

  246. 		 * Clears the currently selected item in the list and sets the <code>selectedIndex</code> property to -1.
         *
         * @includeExample examples/List.clearSelection.1.as -noswf
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    247. 

  247. 		 */
    248. 

  248. 		public function clearSelection () : void;

    249. 

  249. 		/**
    250. 

  250. 		 * Retrieves the ICellRenderer for a given item object, if there is one. 
		 * This method always returns <code>null</code>.
         *
         * @param item The item in the data provider.
         *
         * @return A value of <code>null</code>.
         *
		 * @includeExample examples/SelectableList.itemToCellRenderer.1.as -noswf
		 *
		 * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    251. 

  251. 		 */
    252. 

  252. 		public function itemToCellRenderer (item:Object) : ICellRenderer;

    253. 

  253. 		/**
    254. 

  254. 		 * Appends an item to the end of the list of items. 
		 *
		 * <p>An item should contain <code>label</code> and <code>data</code> 
		 * properties; however, items that contain other properties can also 
		 * be added to the list. By default, the <code>label</code> property of 
		 * an item is used to display the label of the row; the <code>data</code> 
		 * property is used to store the data of the row. </p>
		 * 
         * @param item The item to be added to the data provider.
         *
         * @see #addItemAt()
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    255. 

  255. 		 */
    256. 

  256. 		public function addItem (item:Object) : void;

    257. 

  257. 		/**
    258. 

  258. 		 * Inserts an item into the list at the specified index location. The indices of 
		 * items at or after the specified index location are incremented by 1.
         *
         * @param item The item to be added to the list.
         *
         * @param index The index at which to add the item.
		 *
         * @throws RangeError The specified index is less than 0 or greater than or equal to the length of the data provider.
         *
         * @see #addItem()
         * @see #replaceItemAt()
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    259. 

  259. 		 */
    260. 

  260. 		public function addItemAt (item:Object, index:uint) : void;

    261. 

  261. 		/**
    262. 

  262. 		 * Removes all items from the list. 
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    263. 

  263. 		 */
    264. 

  264. 		public function removeAll () : void;

    265. 

  265. 		/**
    266. 

  266. 		 * Retrieves the item at the specified index.
         * 
         * @param index The index of the item to be retrieved.
         *
         * @return The object at the specified index location.
		 *
         * @throws RangeError The specified index is less than 0 or greater than or equal to the length of the data provider.
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    267. 

  267. 		 */
    268. 

  268. 		public function getItemAt (index:uint) : Object;

    269. 

  269. 		/**
    270. 

  270. 		 * Removes the specified item from the list. 
         *
         * @param item The item to be removed.
         *
         * @return The item that was removed.
		 *
         * @throws RangeError The item could not be found.
         *
         * @see #removeAll()
         * @see #removeItemAt()
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    271. 

  271. 		 */
    272. 

  272. 		public function removeItem (item:Object) : Object;

    273. 

  273. 		/**
    274. 

  274. 		 * Removes the item at the specified index position. The indices of 
		 * items after the specified index location are decremented by 1.
         *
         * @param index The index of the item in the data provider to be removed.
         *
         * @return The item that was removed.
         *
         * @see #removeAll()
         * @see #removeItem()
         * @see #replaceItemAt()
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    275. 

  275. 		 */
    276. 

  276. 		public function removeItemAt (index:uint) : Object;

    277. 

  277. 		/**
    278. 

  278. 		 * Replaces the item at the specified index location with another item. 
		 * This method modifies the data provider of the List component. If 
		 * the data provider is shared with other components, the data that is
		 * provided to those components is also updated.
         *
         * @param item The item to replace the item at the specified index location.
         *
         * @param index The index position of the item to be replaced.
         *
         * @return The item that was replaced.
		 *
         * @throws RangeError The specified index is less than 0 or greater than or equal to the length of the data provider.
         *
         * @see #removeItemAt()
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    279. 

  279. 		 */
    280. 

  280. 		public function replaceItemAt (item:Object, index:uint) : Object;

    281. 

  281. 		/**
    282. 

  282. 		 * Invalidates the whole list, forcing the list items to be redrawn.
         *
         * @see #invalidateItem()
         * @see #invalidateItemAt()
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    283. 

  283. 		 */
    284. 

  284. 		public function invalidateList () : void;

    285. 

  285. 		/**
    286. 

  286. 		 * Invalidates a specific item renderer.
		 *
         * @param item The item in the data provider to invalidate.
         *
         * @see #invalidateItemAt()
         * @see #invalidateList()
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
		 *
		 * @internal [kenos] This doesn't make sense. It says the method invalidates an item renderer,
		 *                   but the param description for item says that it receives "the data provider to invalidate."
		 *                   Isn't the item renderer distinct from the item? There is a similar problem in the next method.
    287. 

  287. 		 */
    288. 

  288. 		public function invalidateItem (item:Object) : void;

    289. 

  289. 		/**
    290. 

  290. 		 * Invalidates the renderer for the item at the specified index.
		 *
         * @param index The index of the item in the data provider to invalidate.
         *
         * @see #invalidateItem()
         * @see #invalidateList()
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
		 *
		 * @internal [kenos] This method appears to invalid an item, but it is described as
		 *                   invalidating an item renderer. What is correct?
    291. 

  291. 		 */
    292. 

  292. 		public function invalidateItemAt (index:uint) : void;

    293. 

  293. 		/**
    294. 

  294. 		 * Sorts the elements of the current data provider. This method 
		 * performs a sort based on the Unicode values of the elements. ASCII is a 
		 * subset of Unicode.
		 * 
		 * @param sortArgs The arguments against which to sort.
		 *
         * @return The return value depends on whether any parameters are passed to 
		 *         this method. For more information, see the <code>Array.sort()</code> method. 
		 *         Note that this method returns 0 when the <code>sortArgs</code> parameter 
         *         is set to <code>Array.UNIQUESORT</code>.
         *
		 * @see #sortItemsOn()
         * @see Array#sort()
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    295. 

  295. 		 */
    296. 

  296. 		public function sortItems (...sortArgs:Array) : *;

    297. 

  297. 		/**
    298. 

  298. 		 * Sorts the elements of the current data provider by one or more  
		 * of its fields.
		 * 
		 * @param field The field on which to sort.
		 * @param options Sort arguments that are used to override the default sort behavior. 
		 *                Separate two or more arguments with the bitwise OR (|) operator.
		 *
         * @return The return value depends on whether any parameters are passed to this
		 *         method. For more information, see the <code>Array.sortOn()</code> method. 
		 *         Note that this method returns 0 when the <code>sortOption</code> parameter  
         *         is set to <code>Array.UNIQUESORT</code>.
         *
         * @includeExample examples/SelectableList.sortItemsOn.1.as -noswf
         *
		 * @see #sortItems()
         * @see fl.data.DataProvider#sortOn() DataProvider.sortOn()
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    299. 

  299. 		 */
    300. 

  300. 		public function sortItemsOn (field:String, options:Object = null) : *;

    301. 

  301. 		/**
    302. 

  302. 		 * Checks whether the specified item is selected in the list. 
		 *
		 * @param item The item to check.
		 *
         * @return This method returns <code>true</code> if the specified item is selected; 
		 *         otherwise, if the specified item has a value of <code>null</code> or is not
		 *         included in the list, this method returns <code>false</code>.
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    303. 

  303. 		 */
    304. 

  304. 		public function isItemSelected (item:Object) : Boolean;

    305. 

  305. 		/**
    306. 

  306. 		 * Scrolls the list to the item at the location indicated by    
		 * the current value of the <code>selectedIndex</code> property.
         *
         * @see #selectedIndex
		 * @see #scrollToIndex()
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    307. 

  307. 		 */
    308. 

  308. 		public function scrollToSelected () : void;

    309. 

  309. 		/**
    310. 

  310. 		 * Scrolls the list to the item at the specified index. If the index 
		 * is out of range, the scroll position does not change.
		 *
		 * @param newCaretIndex The index location to scroll to.
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    311. 

  311. 		 */
    312. 

  312. 		public function scrollToIndex (newCaretIndex:int) : void;

    313. 

  313. 		/**
    314. 

  314. 		 * Returns the index of the next item in the dataProvider in which
		 * the label's first character matches a specified string character.
		 * If the search reaches the end of the dataProvider without searching
		 * all the items, it will loop back to the start.  The search does not
		 * include the startIndex.
		 * 
		 * @param firstLetter The string character to search for
		 * @param startIndex The index in the dataProvider to start at.
		 *
		 * @return The index of the next item in the dataProvider.
		 *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    315. 

  315. 		 */
    316. 

  316. 		public function getNextIndexAtLetter (firstLetter:String, startIndex:int = -1) : int;

    317. 

  317. 		/**
    318. 

  318. 		 * Retrieves the string that the renderer displays for the given data object 
         * based on the <code>label</code> properties of the object.  This method
		 * is intended to be overwritten in sub-components.  For example, List has
		 * a <code>labelField</code> and a <code>labelFunction</code> to derive the
		 * label.
		 *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    319. 

  319. 		 */
    320. 

  320. 		public function itemToLabel (item:Object) : String;

    321. 

  321. 		/**
    322. 

  322. 		 * Sets a style on the renderers in the list.
		 *
		 * @param name The name of the style to be set.
		 * @param style The value of the style to be set.
         *
         * @includeExample examples/SelectableList.setRendererStyle.1.as -noswf
         * @includeExample examples/SelectableList.setRendererStyle.2.as -noswf
         * @includeExample examples/SelectableList.setRendererStyle.3.as -noswf
         * @includeExample examples/SelectableList.setRendererStyle.4.as -noswf
		 *
         * @see #clearRendererStyle()
         * @see #getRendererStyle()
         * 
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    323. 

  323. 		 */
    324. 

  324. 		public function setRendererStyle (name:String, style:Object, column:uint = 0) : void;

    325. 

  325. 		/**
    326. 

  326. 		 * Retrieves a style that is set on the renderers in the list.
		 *
		 * @param name The name of the style to be retrieved.
		 * @param style The value of the style to be retrieved.
         *
         * @see #clearRendererStyle()
         * @see #setRendererStyle()
		 *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    327. 

  327. 		 */
    328. 

  328. 		public function getRendererStyle (name:String, column:int = -1) : Object;

    329. 

  329. 		/**
    330. 

  330. 		 * Clears a style that is set on the renderers in the list.
		 *
		 * @param name The name of the style to be cleared.
		 *
         * @see #getRendererStyle()
         * @see #setRendererStyle()
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    331. 

  331. 		 */
    332. 

  332. 		public function clearRendererStyle (name:String, column:int = -1) : void;

    333. 

  333. 		/**
    334. 

  334. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    335. 

  335. 		 */
    336. 

  336. 		protected function configUI () : void;

    337. 

  337. 		/**
    338. 

  338. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    339. 

  339. 		 */
    340. 

  340. 		protected function _invalidateList () : void;

    341. 

  341. 		/**
    342. 

  342. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    343. 

  343. 		 */
    344. 

  344. 		protected function handleDataChange (event:DataChangeEvent) : void;

    345. 

  345. 		/**
    346. 

  346. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    347. 

  347. 		 */
    348. 

  348. 		protected function handleCellRendererMouseEvent (event:MouseEvent) : void;

    349. 

  349. 		/**
    350. 

  350. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    351. 

  351. 		 */
    352. 

  352. 		protected function handleCellRendererClick (event:MouseEvent) : void;

    353. 

  353. 		/**
    354. 

  354. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    355. 

  355. 		 */
    356. 

  356. 		protected function handleCellRendererChange (event:Event) : void;

    357. 

  357. 		/**
    358. 

  358. 		 * @private (protected)
    359. 

  359. 		 */
    360. 

  360. 		protected function handleCellRendererDoubleClick (event:MouseEvent) : void;

    361. 

  361. 		/**
    362. 

  362. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    363. 

  363. 		 */
    364. 

  364. 		protected function setHorizontalScrollPosition (scroll:Number, fireEvent:Boolean = false) : void;

    365. 

  365. 		/**
    366. 

  366. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    367. 

  367. 		 */
    368. 

  368. 		protected function setVerticalScrollPosition (scroll:Number, fireEvent:Boolean = false) : void;

    369. 

  369. 		/**
    370. 

  370. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    371. 

  371. 		 */
    372. 

  372. 		protected function draw () : void;

    373. 

  373. 		/**
    374. 

  374. 		 * @private (protected)
    375. 

  375. 		 */
    376. 

  376. 		protected function drawLayout () : void;

    377. 

  377. 		/**
    378. 

  378. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    379. 

  379. 		 */
    380. 

  380. 		protected function updateRendererStyles () : void;

    381. 

  381. 		/**
    382. 

  382. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    383. 

  383. 		 */
    384. 

  384. 		protected function drawList () : void;

    385. 

  385. 		/**
    386. 

  386. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    387. 

  387. 		 */
    388. 

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

    389. 

  389. 		/**
    390. 

  390. 		 * @private (protected)
		 *  Moves the selection in a horizontal direction in response
		 *  to the user selecting items using the left-arrow or right-arrow
		 *  keys and modifiers such as  the Shift and Ctrl keys.
		 *
		 *  <p>Not implemented in List because the default list
		 *  is single column and therefore doesn't scroll horizontally.</p>
		 *
		 *  @param code The key that was pressed (e.g. Keyboard.LEFT)
         *
		 *  @param shiftKey <code>true</code> if the shift key was held down when
		 *         the keyboard key was pressed.
         *
		 *  @param ctrlKey <code>true</code> if the ctrl key was held down when
         *         the keyboard key was pressed
         *
    391. 

  391. 		 */
    392. 

  392. 		protected function moveSelectionHorizontally (code:uint, shiftKey:Boolean, ctrlKey:Boolean) : void;

    393. 

  393. 		/**
    394. 

  394. 		 * @private (protected)
		 *  Moves the selection in a vertical direction in response
		 *  to the user selecting items using the up-arrow or down-arrow
		 *  Keys and modifiers such as the Shift and Ctrl keys.
		 *
		 *  @param code The key that was pressed (e.g. Keyboard.DOWN)
		 *
         *  @param shiftKey <code>true</code> if the shift key was held down when
		 *         the keyboard key was pressed.
         *
		 *  @param ctrlKey <code>true</code> if the ctrl key was held down when
         *         the keyboard key was pressed
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    395. 

  395. 		 */
    396. 

  396. 		protected function moveSelectionVertically (code:uint, shiftKey:Boolean, ctrlKey:Boolean) : void;

    397. 

  397. 		/**
    398. 

  398. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    399. 

  399. 		 */
    400. 

  400. 		protected function initializeAccessibility () : void;

    401. 

  401. 		/**
    402. 

  402. 		 * @private (protected)
         *
         * @langversion 3.0
         * @playerversion Flash 9.0.28.0
    403. 

  403. 		 */
    404. 

  404. 		protected function onPreChange (event:DataChangeEvent) : void;

    405. 

  405. 	}

    406. 

  406. }
    407.