Packageqnx.ui.listClasses
Classpublic class RoundList
InheritanceRoundList Inheritance List Inheritance UIComponent Inheritance flash.display.MovieClip
Implements IDataViewer

The RoundList class allows you to display cells in a scrolling vertical list. The round list has no scroll bar, and continues to scroll from the beginning once the final cell has been reached.

View the examples

See also

List


Public Properties
 PropertyDefined By
 InheritedallowDeselect : Boolean
Determines if a selected cell in the list can be deselected when pressed.
List
 InheritedcolumnWidth : int
Gets or sets the width of each column in the list.
List
 Inheritedcontainment : String
Gets or sets a property that determines how a component is contained within a parent container.
UIComponent
 InheriteddataProvider : IDataProvider
Gets or sets the DataProvider instance for the list.
List
 InheritedenableShadows : Boolean
Sets or gets whether the scroll shadows should be shown.
List
 InheritedfirstVisibleItem : ICellRenderer
[read-only] Returns the first visible item in the view port area as defined by the width and height
List
 InheritedfooterView : DisplayObject
Gets or sets the footer view.
List
 InheritedlastVisibleItem : ICellRenderer
[read-only] Returns the last visible item in the view port area as defined by the width and height
List
 InheritedrowHeight : int
Gets or sets the height of each row in the list.
List
 Inheritedscrollable : Boolean
Gets or sets a value that determines whether a list can be scrolled.
List
 InheritedscrollBarAlpha : Number
Gets or sets the opacity value for the scroll bar on the list.
List
 InheritedscrollBarColor : Number
Gets or sets the color of the scroll bar.
List
 InheritedscrollBarOffset : int
Gets or sets the x or y postion of the scrollbar, in pixels.
List
 InheritedscrollDirection : String
Gets and sets the scroll direction of the list.
List
 InheritedselectedIndex : int
Gets or sets the index of the currently selected item in a single-selection list.
List
 InheritedselectedIndices : Array
Gets or sets the selected cells at the specified indices in a multi-selectable list.
List
 InheritedselectedItem : Object
Gets or sets the currently selected item in a single-selectable list.
List
 InheritedselectedItems : Array
Gets or sets the group of selected items (selectedItems) in a multi-selectable list.
List
 InheritedselectionMode : int
Gets or sets a value that determines whether or not selection mode is enabled.
List
 Inheritedsize : Number
Gets or sets the size for this component (as a percentage of the container's size, or in pixels).
UIComponent
 InheritedsizeMode : String
Gets or sets the size mode for this component.
UIComponent
 InheritedsizeUnit : String
Gets or sets the unit of measure for the size property.
UIComponent
Public Methods
 MethodDefined By
  
Creates a RoundList instance.
RoundList
 Inherited
addItem(item:Object):void
Appends an item to the end of the list.
List
 Inherited
addItemAt(item:Object, index:int):void
Adds an item to the list at the specified index.
List
 Inherited
addItemsAt(items:Array, index:int):void
Adds an array item at the specified index.
List
 Inherited
destroy():void
Call this method when you want to have your object collected by the garbage collector.
UIComponent
 Inherited
drawNow():void
Calls the draw() method.
UIComponent
 Inherited
getIsCellVisibleAtIndex(index:int):Boolean
Returns a Boolean indicating whether or not a cell at a given index is visible in the virtual area.
List
 Inherited
getItemAt(index:int):Object
Returns the item in the DataProvider at the specified index.
List
 Inherited
invalidate(property:String, invalidateNow:Boolean = false):void
Marks the property as invalid and the draw() method is called on the next frame or the next render, whichever comes first.
UIComponent
 Inherited
removeAll():void
Removes all the items from the list.
List
 Inherited
removeItem(item:Object):void
Removes a given item from the list.
List
 Inherited
removeItemAt(index:int):void
Removes an item from list at the specified index.
List
 Inherited
replaceItem(item:Object, oldObject:Object):void
Replaces an item, given the new item object and the old item.
List
 Inherited
replaceItemAt(item:Object, index:int):void
Replaces the item in the list at the specified index with a new item.
List
 Inherited
scrollIndexVisible(index:int, seconds:Number = 1):void
Scrolls a given item into view, given an index and an animation duration (in seconds).
List
 Inherited
scrollToIndex(index:int, seconds:Number = 1):void
Animates the cell at the specified index into view.
List
 Inherited
setPosition(x:Number, y:Number):void
Sets the x and y position of the component.
UIComponent
 Inherited
setSize(w:Number, h:Number):void
Sets the width and height of the component.
UIComponent
 Inherited
setSkin(skin:Object):void
Sets the cell renderer to use to populate the list.
List
 Inherited
updateItem(value:Object, oldObject:Object):void
Updates an item in the list, given the new item and the item to update.
List
 Inherited
updateItemAt(item:Object, index:int):void
Updates the item in the list at the specified index, given the new item.
List
 Inherited
updateItemsAt(items:Array, index:int):void
Updates the items starting at the specified index with new items.
List
Protected Methods
 MethodDefined By
 Inherited
callLater(method:Function):void
Calls the specified method on the next frame or the next render, which ever happens first.
UIComponent
 Inherited
createInstance(linkage:Object):DisplayObject
Calling this method will attempt to create a DisplayObject instance based on the value of the linkage parameter.
UIComponent
 Inherited
draw():void
Called every time you set the width and height of the component.
UIComponent
 Inherited
isInvalid(property:String, ... properties):Boolean
Checks to see if the property is invalid and returns true if it is.
UIComponent
 Inherited
onAdded():void
Called when the instance is added to the stage.
UIComponent
 Inherited
onRemoved():void
Called when the instance is removed from the stage.
UIComponent
 Inherited
setEnabled(val:Boolean):void
Called when the enabled property changes.
UIComponent
 Inherited
validate(property:String):void
Lets the component know that the specified property has been validated.
UIComponent
Events
 Event Summary Defined By
 InheritedDispatched when a change has occurred in the DataProvider.List
 Inherited Dispatched when a cell renderer is clicked.List
 Inherited Dispatched when scrolling begins.List
 Inherited Dispatched when scrolling ends.List
 Inherited Dispatched when scrolling occurs.List
Constructor Detail
RoundList()Constructor
public function RoundList()

Creates a RoundList instance.

Examples

In the following example, a RoundList class is instantiated and initialized:

package
{
    import flash.display.Sprite;    
    
    import qnx.ui.data.DataProvider;
    import qnx.ui.events.ListEvent;
    import qnx.ui.listClasses.RoundList;
    import qnx.ui.listClasses.ListSelectionMode;
    
    [SWF(height="600", width="1024", frameRate="30", backgroundColor="#FFFFFF")]
    public class RoundListSample extends Sprite
    {
        public function RoundListSample()
        {
            initializeUI();
        }
        
        private function initializeUI():void
        {
            
            var arrMonth:Array=[];
            // add objects with a label property
            arrMonth.push({label: "Bananas"});
            arrMonth.push({label: "Apples"});
            arrMonth.push({label: "Bacon"});
            arrMonth.push({label: "Hot dogs"});
            arrMonth.push({label: "Celery"});
                        
            var myList:RoundList = new RoundList();            
            myList.setPosition(100, 100);            
            myList.width = 200;            
            myList.height = 200;
            myList.topOffSet = 3;        
            
            //set the dataProvider
            myList.selectionMode = ListSelectionMode.SINGLE;        
            myList.dataProvider = new DataProvider(arrMonth);        
                        
            myList.addEventListener(ListEvent.ITEM_CLICKED, onListClick);
            
            this.addChild(myList);
            
        }
        
        private function onListClick(event:ListEvent):void {
            
            trace("Item clicked: " + event.data.label);
            trace("Index clicked: " + event.index);
        }
            
    }
}