topical media & game development

topical media & game development

[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

student-ar-fl-controls-SelectableList.ax

student-ar-fl-controls-SelectableList.ax [swf] flex


  // Copyright 2007. Adobe Systems Incorporated. All Rights Reserved.
  package fl.controls {        
  
          import fl.containers.BaseScrollPane;
          import fl.controls.listClasses.CellRenderer;
          import fl.controls.listClasses.ICellRenderer;
          import fl.controls.listClasses.ListData;
          import fl.controls.ScrollPolicy;
          import fl.core.InvalidationType;
          import fl.core.UIComponent;
          import fl.data.DataProvider;
          import fl.data.SimpleCollectionItem;
          import fl.events.DataChangeEvent;
          import fl.events.DataChangeType;
          import fl.events.ListEvent;
          import fl.events.ScrollEvent;
          import fl.managers.IFocusManagerComponent;
          import flash.display.DisplayObject;
          import flash.display.Sprite;
          import flash.events.Event;
          import flash.events.KeyboardEvent;
          import flash.events.MouseEvent;
          import flash.ui.Keyboard;
          import flash.utils.Dictionary;
  
      //--------------------------------------
      //  Events
      //--------------------------------------

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


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

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


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

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


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

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


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

Dispatched when the user clicks an item in the component. 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. @eventType fl.events.ListEvent.ITEM_CLICK @langversion 3.0 @playerversion Flash 9.0.28.0


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

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


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

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


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

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


  
          [Event(name="scroll", type="fl.events.ScrollEvent")]
  
          //--------------------------------------
          //  Styles
          //--------------------------------------

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


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

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


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

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


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

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


  
      [Style(name="contentPadding", type="Number", format="Length")]
  
      //--------------------------------------
      //  Class description
      //--------------------------------------

The @ax-student-ar-fl-controls-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. Note: This class does not create a component; it is exposed only so that it can be extended.
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


  
          public class @ax-student-ar-fl-controls-SelectableList extends BaseScrollPane implements IFocusManagerComponent {

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected var listHolder:Sprite;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected var list:Sprite;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected var _dataProvider:DataProvider;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected var activeCellRenderers:Array;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected var availableCellRenderers:Array;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected var renderedItems:Dictionary;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected var invalidItems:Dictionary;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected var _horizontalScrollPosition:Number;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected var _verticalScrollPosition:Number;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected var _allowMultipleSelection:Boolean=false;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected var _selectable:Boolean=true;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected var _selectedIndices:Array;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected var caretIndex:int = -1;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected var lastCaretIndex:int = -1;

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected var preChangeItems:Array;

@private


  
                  private var collectionItemImport:SimpleCollectionItem;

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected var rendererStyles:Object;

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected var updatedRendererStyles:Object;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  private static var defaultStyles:Object = {
                                                                                                          skin:"List_skin",
                                                                                                          cellRenderer:CellRenderer,
                                                                                                          contentPadding:null,
                                                                                                          disabledAlpha:null
                                                                                                          };

@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


  
                  public static function getStyleDefinition():Object { 
                          return mergeStyles(defaultStyles, BaseScrollPane.getStyleDefinition());
                  }

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


  
                  public static var createAccessibilityImplementation:Function;

Creates a new @ax-student-ar-fl-controls-SelectableList instance. @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function @ax-student-ar-fl-controls-SelectableList() {
                          super();
                          activeCellRenderers = []
                          availableCellRenderers = [];
                          invalidItems = new Dictionary(true);
                          renderedItems = new Dictionary(true);
                          _selectedIndices = [];
                          if (dataProvider == null) { dataProvider = new DataProvider(); }
                          verticalScrollPolicy = ScrollPolicy.AUTO;
                          rendererStyles = {};
                          updatedRendererStyles = {};
                  }
                  
                  [Inspectable(defaultValue=true, verbose=1)]

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  override public function set enabled(value:Boolean):void {
                          super.enabled = value;
                          list.mouseChildren = _enabled;
                  }

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


  
                  public function get dataProvider():DataProvider {
                          // return the original data source:
                          return _dataProvider;
                  }
                  
                  [Collection(collectionClass="fl.data.DataProvider", collectionItem="fl.data.SimpleCollectionItem", identifier="item")]

@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function set dataProvider(value:DataProvider):void {
                          if (_dataProvider != null) {
                                  _dataProvider.removeEventListener(DataChangeEvent.DATA_CHANGE,handleDataChange);
                                  _dataProvider.removeEventListener(DataChangeEvent.PRE_DATA_CHANGE, onPreChange);
                          }
                          _dataProvider = value;
                          _dataProvider.addEventListener(DataChangeEvent.DATA_CHANGE,handleDataChange,false,0,true);
                          _dataProvider.addEventListener(DataChangeEvent.PRE_DATA_CHANGE,onPreChange,false,0,true);
                          clearSelection();
                          invalidateList();
                  }

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


  
                  override public function get maxHorizontalScrollPosition():Number {
                          return _maxHorizontalScrollPosition;
                  }

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function set maxHorizontalScrollPosition(value:Number):void {
                          _maxHorizontalScrollPosition = value;
                          invalidate(InvalidationType.SIZE);
                  }

Gets the number of items in the data provider. @includeExample examples/@ax-student-ar-fl-controls-SelectableList.length.1.as -noswf @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function get length():uint {
                          return _dataProvider.length;
                  }
                  
                  [Inspectable(defaultValue=false)]

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


                  
                  public function get allowMultipleSelection():Boolean {
                          return _allowMultipleSelection;
                  }

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function set allowMultipleSelection(value:Boolean):void {
                          if (value == _allowMultipleSelection) { return; }
                          _allowMultipleSelection = value;
                          if (!value && _selectedIndices.length > 1) {
                                  _selectedIndices = [_selectedIndices.pop()];
                                  invalidate(InvalidationType.DATA);
                          }
                  }

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


  
                  public function get selectable():Boolean {
                          return _selectable;
                  }

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function set selectable(value:Boolean):void {
                          if (value == _selectable) { return; }
                          if (!value) { selectedIndices = []; }
                          _selectable = value;
                  }

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. 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. 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. 
see: #selectedIndices
see: #selectedItem @includeExample examples/@ax-student-ar-fl-controls-SelectableList.selectedIndex.1.as -noswf @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function get selectedIndex():int {
                          return (_selectedIndices.length == 0) ? -1 : _selectedIndices[_selectedIndices.length-1];
                  }

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function set selectedIndex(value:int):void {
                          selectedIndices = (value == -1) ? null : [value];
                  }

Gets or sets an array that contains the items that were selected from a multiple-selection list. 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>.  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>.
see: #allowMultipleSelection
see: #selectedIndex
see: #selectedItems @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function get selectedIndices():Array {
                          return _selectedIndices.concat();
                  }

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function set selectedIndices(value:Array):void {
                          if (!_selectable) { return; }
                          _selectedIndices = (value == null) ? [] : value.concat();
                          invalidate(InvalidationType.SELECTED);
                  }

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. If no selection is made, the value of this property is <code>null</code>.
see: #selectedIndex
see: #selectedItems @includeExample examples/@ax-student-ar-fl-controls-SelectableList.selectedIndex.1.as -noswf @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function get selectedItem():Object {
                          return (_selectedIndices.length == 0) ? null : _dataProvider.getItemAt(selectedIndex);
                  }

@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function set selectedItem(value:Object):void {
                          var index:int = _dataProvider.getItemIndex(value);
                          selectedIndex = index;
                  }

Gets or sets an array that contains the objects for the items that were selected from the multiple-selection list. 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>. @includeExample examples/@ax-student-ar-fl-controls-SelectableList.selectedItems.1.as -noswf
see: #allowMultipleSelection
see: #selectedIndices
see: #selectedItem @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function get selectedItems():Array {
                          var items:Array = [];
                          for (var i:uint = 0; i < _selectedIndices.length; i++) {
                                  items.push(_dataProvider.getItemAt(_selectedIndices[i]));
                          }
                          return items;
                  }

@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function set selectedItems(value:Array):void {
                          if (value == null) {
                                  selectedIndices = null;
                                  return;
                          }
                          var indices:Array = [];
                          for (var i:uint = 0; i < value.length; i++) {
                                  var index:int = _dataProvider.getItemIndex(value[i]);
                                  if (index != -1) {
                                          indices.push(index);
                                  }
                          }
                          selectedIndices = indices;
                  }

Gets the number of rows that are at least partially visible in the list. Note: This property must be overridden in any class that extends @ax-student-ar-fl-controls-SelectableList. @includeExample examples/@ax-student-ar-fl-controls-SelectableList.rowCount.1.as -noswf @default 0 @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function get rowCount():uint {
                          return 0;
                  }

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


  
                  public function clearSelection():void {
                          selectedIndex = -1;
                  }

Retrieves the ICellRenderer for a given item object, if there is one. This method always returns <code>null</code>.
parameter: item The item in the data provider.
returns: A value of null. @includeExample examples/@ax-student-ar-fl-controls-SelectableList.itemToCellRenderer.1.as -noswf @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function itemToCellRenderer(item:Object):ICellRenderer {
                          if(item != null) {
                                  for(var index in activeCellRenderers) {
                                          var renderer:ICellRenderer = activeCellRenderers[index] as ICellRenderer;
                                          if(renderer.data == item) {
                                                  return renderer;
                                          }
                                  }
                          }
                          return null;
                  }

Appends an item to the end of the list of items. 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. 
parameter: item The item to be added to the data provider.
see: #addItemAt() @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function addItem(item:Object):void {
                          _dataProvider.addItem(item);
                          invalidateList();
                  }

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.
parameter: item The item to be added to the list.
parameter: 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


  
                  public function addItemAt(item:Object,index:uint):void {
                          _dataProvider.addItemAt(item,index);
                          invalidateList();
                  }

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


  
                  public function removeAll():void {
                          _dataProvider.removeAll();
                  }

Retrieves the item at the specified index.
parameter: index The index of the item to be retrieved.
returns: 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


  
                  public function getItemAt(index:uint):Object {
                          return _dataProvider.getItemAt(index);
                  }

Removes the specified item from the list.
parameter: item The item to be removed.
returns: 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


                   
                  public function removeItem(item:Object):Object {
                          return _dataProvider.removeItem(item);
                  }

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


  
                  public function removeItemAt(index:uint):Object {
                          return _dataProvider.removeItemAt(index);
                  }
  
          // V2 has order of arguments backwards.

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.
parameter: item The item to replace the item at the specified index location.
parameter: index The index position of the item to be replaced.
returns: 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


  
                  public function replaceItemAt(item:Object, index:uint):Object {
                          return _dataProvider.replaceItemAt(item, index);
                  }

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


  
                  public function invalidateList():void {
                          _invalidateList();
                          invalidate(InvalidationType.DATA);
                  }

Invalidates a specific item renderer.
parameter: 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.


  
                  public function invalidateItem(item:Object):void {
                          if (renderedItems[item] == null) { return; }
                          invalidItems[item] = true;
                          invalidate(InvalidationType.DATA);
                  }

Invalidates the renderer for the item at the specified index.
parameter: 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?


  
                  public function invalidateItemAt(index:uint):void {
                          var item:Object = _dataProvider.getItemAt(index);
                          if (item != null) {
                                  invalidateItem(item);
                          }
                  }

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.
parameter: sortArgs The arguments against which to sort.
returns: 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


  
                   public function sortItems(...sortArgs:Array):* {
                          return _dataProvider.sort.apply(_dataProvider,sortArgs);
                  }

Sorts the elements of the current data provider by one or more of its fields.
parameter: field The field on which to sort.
parameter: options Sort arguments that are used to override the default sort behavior. Separate two or more arguments with the bitwise OR (|) operator.
returns: 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/@ax-student-ar-fl-controls-SelectableList.sortItemsOn.1.as -noswf
see: #sortItems()
see: fl.data.DataProvider#sortOn() DataProvider.sortOn() @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function sortItemsOn(field:String,options:Object=null):* {
                          return _dataProvider.sortOn(field,options);
                  }

Checks whether the specified item is selected in the list.
parameter: item The item to check.
returns: This method returns true 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


  
                  public function isItemSelected(item:Object):Boolean {
                          return selectedItems.indexOf(item) > -1;
                  }

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


  
                  public function scrollToSelected():void {
                          scrollToIndex(selectedIndex);
                  }

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


  
                  public function scrollToIndex(newCaretIndex:int):void {
                          // Handle in subclasses.        
                  }

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.
parameter: firstLetter The string character to search for
parameter: startIndex The index in the dataProvider to start at.
returns: The index of the next item in the dataProvider. @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function getNextIndexAtLetter(firstLetter:String, startIndex:int=-1):int {
                          if (length == 0) { return -1; }
                          firstLetter = firstLetter.toUpperCase();
                          var l:int = length-1;
                          for (var i:Number=0; i<l; i++) {
                                  var index:Number = startIndex + 1 + i;
                                  if (index > length-1) {
                                          index -= length;
                                  }
                                  var item:Object = getItemAt(index);
                                  if (item == null) { break; }
                                  var label:String = itemToLabel(item);
                                  if (label == null) { continue; }
                                  if (label.charAt(0).toUpperCase() == firstLetter) {
                                          return index;
                                          break;
                                  }
                          }
                          return -1;
                  }

@private

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


  
                  public function itemToLabel(item:Object):String {
                          return item["label"]; // Use bracket access in case object has no property.
                  }

Sets a style on the renderers in the list.
parameter: name The name of the style to be set.
parameter: style The value of the style to be set. @includeExample examples/@ax-student-ar-fl-controls-SelectableList.setRendererStyle.1.as -noswf @includeExample examples/@ax-student-ar-fl-controls-SelectableList.setRendererStyle.2.as -noswf @includeExample examples/@ax-student-ar-fl-controls-SelectableList.setRendererStyle.3.as -noswf @includeExample examples/@ax-student-ar-fl-controls-SelectableList.setRendererStyle.4.as -noswf
see: #clearRendererStyle()
see: #getRendererStyle() @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function setRendererStyle(name:String, style:Object, column:uint=0):void {
                          if (rendererStyles[name] == style) { return; }
                          updatedRendererStyles[name] = style;
                          rendererStyles[name] = style;
                          invalidate(InvalidationType.RENDERER_STYLES);
                  }

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


  
                  public function getRendererStyle(name:String, column:int=-1):Object {
                          return rendererStyles[name];        
                  }

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


  
                  public function clearRendererStyle(name:String, column:int=-1):void {
                          delete rendererStyles[name];
                          updatedRendererStyles[name] = null; // Do not delete, so it can clear the style from current renderers.
                          invalidate(InvalidationType.RENDERER_STYLES);
                  }

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  override protected function configUI():void {
                          super.configUI();
                          
                          listHolder = new Sprite();
                          addChild(listHolder);
                          listHolder.scrollRect = contentScrollRect;
                          
                          list = new Sprite();
                          listHolder.addChild(list);
                  }

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected function _invalidateList():void {
                          availableCellRenderers = [];
                          while (activeCellRenderers.length > 0) {
                                  list.removeChild(activeCellRenderers.pop() as DisplayObject);
                          }
                  }

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected function handleDataChange(event:DataChangeEvent):void {
                          var startIndex:int = event.startIndex;
                          var endIndex:int = event.endIndex;
                          var changeType:String = event.changeType;
                          var i:uint;
                          if (changeType == DataChangeType.INVALIDATE_ALL) {
                                  clearSelection();
                                  invalidateList();
                          } else if (changeType == DataChangeType.INVALIDATE) {
                                  for (i = 0; i < event.items.length; i++) {
                                          invalidateItem(event.items[i]);
                                  }
                          } else if (changeType == DataChangeType.ADD) {
                                  for (i = 0; i<_selectedIndices.length; i++) {
                                          if (_selectedIndices[i] >= startIndex) {
                                                  _selectedIndices[i] += startIndex-endIndex;
                                          }
                                  }
                          } else if (changeType == DataChangeType.REMOVE) {
                                  for (i = 0; i<_selectedIndices.length; i++) {
                                          if (_selectedIndices[i] >= startIndex) {
                                                  if (_selectedIndices[i] <= endIndex) {
                                                          delete(_selectedIndices[i]);
                                                  } else {
                                                          _selectedIndices[i] -= startIndex-endIndex+1;
                                                  }
                                          }
                                  }
                          } else if (changeType == DataChangeType.REMOVE_ALL) {
                                  clearSelection();
                          } else if (changeType == DataChangeType.REPLACE) {
                                  // doesn't need to do anything.
                          } else {
                                  // Using preChangeItems to remember selection
                                  //clearSelection();
                                  selectedItems = preChangeItems;
                                  preChangeItems = null;
                          }
                          invalidate(InvalidationType.DATA);
                  }

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected function handleCellRendererMouseEvent(event:MouseEvent):void {
                          var renderer:ICellRenderer = event.target as ICellRenderer;
                          var evtType:String = (event.type == MouseEvent.ROLL_OVER) ? ListEvent.ITEM_ROLL_OVER : ListEvent.ITEM_ROLL_OUT;
                          dispatchEvent(new ListEvent(evtType,false,false,renderer.listData.column,renderer.listData.row, renderer.listData.index, renderer.data));
                  }

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected function handleCellRendererClick(event:MouseEvent):void {
                          if (!_enabled) { return; }
                          var renderer:ICellRenderer = event.currentTarget as ICellRenderer;
                          var itemIndex:uint = renderer.listData.index;
                          // this event is cancellable:
                          if (!dispatchEvent(new ListEvent(ListEvent.ITEM_CLICK,false,true,renderer.listData.column,renderer.listData.row,itemIndex,renderer.data)) || !_selectable) { return; }
                          var selectIndex:int = selectedIndices.indexOf(itemIndex);
                          var i:int;
                          if (!_allowMultipleSelection) {
                                  if (selectIndex != -1) {
                                          return;
                                  } else {
                                          renderer.selected = true;
                                          _selectedIndices = [itemIndex];
                                  }
                                  lastCaretIndex = caretIndex = itemIndex;
                          } else {
                                  if (event.shiftKey) {
                                          var oldIndex:uint = (_selectedIndices.length > 0) ? _selectedIndices[0] : itemIndex;
                                          _selectedIndices = [];
                                          if (oldIndex > itemIndex) {
                                                  for (i = oldIndex; i >= itemIndex; i--) {
                                                          _selectedIndices.push(i);
                                                  }
                                          } else {
                                                  for (i = oldIndex; i <= itemIndex; i++) {
                                                          _selectedIndices.push(i);
                                                  }
                                          }
                                          caretIndex = itemIndex;
                                  } else if (event.ctrlKey) {
                                          if (selectIndex != -1) {
                                                  renderer.selected = false;
                                                  _selectedIndices.splice(selectIndex,1);
                                          } else {
                                                  renderer.selected = true;
                                                  _selectedIndices.push(itemIndex);
                                          }
                                          caretIndex = itemIndex;
                                  } else {
                                          _selectedIndices = [itemIndex];
                                          lastCaretIndex = caretIndex = itemIndex;
                                  }
                          }
                          dispatchEvent(new Event(Event.CHANGE));
                          invalidate(InvalidationType.DATA);
                  }

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected function handleCellRendererChange(event:Event):void {
                          var renderer:ICellRenderer = event.currentTarget as ICellRenderer;
                          var itemIndex:uint = renderer.listData.index;
                          _dataProvider.invalidateItemAt(itemIndex);
                  }

@private (protected)


  
                  protected function handleCellRendererDoubleClick(event:MouseEvent):void {
                          if (!_enabled) { return; }
                          var renderer:ICellRenderer = event.currentTarget as ICellRenderer;
                          var itemIndex:uint = renderer.listData.index;
                          dispatchEvent(new ListEvent(ListEvent.ITEM_DOUBLE_CLICK,false,true,renderer.listData.column,renderer.listData.row,itemIndex,renderer.data));                
                  }

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  override protected function setHorizontalScrollPosition(scroll:Number,fireEvent:Boolean=false):void {
                          if (scroll == _horizontalScrollPosition) { return; }
                          var delta:Number = scroll-_horizontalScrollPosition;
                          _horizontalScrollPosition = scroll;
                          if (fireEvent) {
                                  dispatchEvent(new ScrollEvent(ScrollBarDirection.HORIZONTAL,delta,scroll));
                          }
                  }

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  override protected function setVerticalScrollPosition(scroll:Number,fireEvent:Boolean=false):void {
                          if (scroll == _verticalScrollPosition) { return; }
                          var delta:Number = scroll-_verticalScrollPosition;
                          _verticalScrollPosition = scroll;
                          if (fireEvent) {
                                  dispatchEvent(new ScrollEvent(ScrollBarDirection.VERTICAL,delta,scroll));
                          }
                  }

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  override protected function draw():void {
                          // this method is overridden in List implementations.
                          super.draw();
                  }

@private (protected)


  
                  override protected function drawLayout():void {
                          super.drawLayout();
                          
                          contentScrollRect = listHolder.scrollRect;
                          contentScrollRect.width = availableWidth;
                          contentScrollRect.height = availableHeight;
                          listHolder.scrollRect = contentScrollRect;
                  }

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected function updateRendererStyles():void {
                          var renderers:Array = availableCellRenderers.concat(activeCellRenderers);
                          var l:uint = renderers.length;
                          for (var i:uint=0; i<l; i++) {
                                  if (renderers[i].setStyle == null) { continue; }
                                  for (var n:String in updatedRendererStyles) {
                                          renderers[i].setStyle(n, updatedRendererStyles[n]);
                                  }
                                  renderers[i].drawNow();
                          }
                          updatedRendererStyles = {};
                  }

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected function drawList():void {
                          // this method is overridden in List implementations.
                  }

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  override protected function keyDownHandler(event:KeyboardEvent):void {
                          if (!selectable) { return; }
                          
                          switch (event.keyCode) {
                                  case Keyboard.UP:
                                  case Keyboard.DOWN:
                                  case Keyboard.END:
                                  case Keyboard.HOME:
                                  case Keyboard.PAGE_UP:
                                  case Keyboard.PAGE_DOWN:
                                          moveSelectionVertically(event.keyCode, event.shiftKey && _allowMultipleSelection, event.ctrlKey && _allowMultipleSelection);
                                          event.stopPropagation();
                                          break;
                                  case Keyboard.LEFT:
                                  case Keyboard.RIGHT:
                                          moveSelectionHorizontally(event.keyCode, event.shiftKey && _allowMultipleSelection, event.ctrlKey && _allowMultipleSelection);
                                          event.stopPropagation();
                                          break;
                          }
                          
                  }

@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. Not implemented in List because the default list is single column and therefore doesn't scroll horizontally.
parameter: code The key that was pressed (e.g. Keyboard.LEFT)
parameter: shiftKey true if the shift key was held down when the keyboard key was pressed.
parameter: ctrlKey true if the ctrl key was held down when the keyboard key was pressed


  
                  protected function moveSelectionHorizontally(code:uint, shiftKey:Boolean, ctrlKey:Boolean):void {}

@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.
parameter: code The key that was pressed (e.g. Keyboard.DOWN)
parameter: shiftKey true if the shift key was held down when the keyboard key was pressed.
parameter: ctrlKey true if the ctrl key was held down when the keyboard key was pressed @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected function moveSelectionVertically(code:uint, shiftKey:Boolean, ctrlKey:Boolean):void {}

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  override protected function initializeAccessibility():void {
                          if (@ax-student-ar-fl-controls-SelectableList.createAccessibilityImplementation != null) {
                                  @ax-student-ar-fl-controls-SelectableList.createAccessibilityImplementation(this);
                          }
                  }

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected function onPreChange(event:DataChangeEvent):void {
                          switch (event.changeType) {
                                  case DataChangeType.REMOVE:
                                  case DataChangeType.ADD:
                                  case DataChangeType.INVALIDATE:
                                  case DataChangeType.REMOVE_ALL:
                                  case DataChangeType.REPLACE:
                                  case DataChangeType.INVALIDATE_ALL:
                                          break;
                                  default:
                                          preChangeItems = selectedItems;        
                                          break;
                          }
                  }
                  
          }
  }

[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

You may not copy or print any of this material without explicit permission of the author or the publisher. In case of other copyright issues, contact the author.