Package | fl.controls |
Class | public class List |
Inheritance | List SelectableList BaseScrollPane UIComponent Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
Implements | IFocusManagerComponent |
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS3 |
Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
The List component consists of items, rows, and a data provider, which are described as follows:
- Item: An ActionScript object that usually contains a descriptive
label
property and adata
property that stores the data associated with that item. - Row: A component that is used to display the item.
- Data provider: A component that models the items that the List component displays.
By default, the List component uses the CellRenderer class to supply the rows in which list items are displayed. You can create these rows programmatically; this is usually done by subclassing the CellRenderer class. The CellRenderer class implements the ICellRenderer interface, which provides the set of properties and methods that the List component uses to manipulate its rows and to send data and state information to each row for display. This includes information about data sizing and selection.
The List component provides methods that act on its data provider--for example, the
addItem()
and removeItem()
methods. You can use these and
other methods to manipulate the data of any array that exists in the same frame as
a List component and then broadcast the changes to multiple views. If a List component
is not provided with an external data provider, these methods automatically create an
instance of a data provider and expose it through the List.dataProvider
property. The List component renders each row by using a Sprite that implements the
ICellRenderer interface. To specify this renderer, use the List.cellRenderer
property. You can also build an Array instance or get one from a server and use it as a
data model for multiple lists, combo boxes, data grids, and so on.
Property | Defined By | ||
---|---|---|---|
accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | ||
accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | ||
allowMultipleSelection : Boolean
Gets a Boolean value that indicates whether more than one list item
can be selected at a time. | SelectableList | ||
alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | ||
blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | DisplayObject | ||
blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | DisplayObject | ||
buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | ||
cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | DisplayObject | ||
cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when
cacheAsBitmap is set to true. | DisplayObject | ||
constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | ||
contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | ||
dataProvider : DataProvider
Gets or sets the data model of the list of items to be viewed. | SelectableList | ||
doubleClickEnabled : Boolean
Specifies whether the object receives doubleClick events. | InteractiveObject | ||
dropTarget : DisplayObject [read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped. | Sprite | ||
enabled : Boolean
Gets or sets a value that indicates whether the component can accept user interaction. | UIComponent | ||
filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | ||
focusEnabled : Boolean
Gets or sets a Boolean value that indicates whether the component can receive focus
after the user clicks it. | UIComponent | ||
focusManager : IFocusManager
Gets or sets the FocusManager that controls focus for this component and its
peers. | UIComponent | ||
focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | ||
graphics : Graphics [read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur. | Sprite | ||
height : Number [override]
Gets or sets the height of the component, in pixels. | UIComponent | ||
hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | ||
horizontalLineScrollSize : Number
Gets or sets a value that describes the amount of content to be scrolled,
horizontally, when a scroll arrow is clicked. | BaseScrollPane | ||
horizontalPageScrollSize : Number
Gets or sets the count of pixels by which to move the scroll thumb
on the horizontal scroll bar when the scroll bar track is pressed. | BaseScrollPane | ||
horizontalScrollBar : ScrollBar [read-only]
Gets a reference to the horizontal scroll bar. | BaseScrollPane | ||
horizontalScrollPolicy : String
Gets or sets a value that indicates the state of the horizontal scroll
bar. | BaseScrollPane | ||
horizontalScrollPosition : Number
Gets or sets a value that describes the horizontal position of the
horizontal scroll bar in the scroll pane, in pixels. | BaseScrollPane | ||
iconField : String
Gets or sets the item field that provides the icon for the item. | List | ||
iconFunction : Function
Gets or sets the function to be used to obtain the icon for the item. | List | ||
labelField : String
Gets or sets the name of the field in the dataProvider object
to be displayed as the label for the TextInput field and drop-down list. | List | ||
labelFunction : Function
Gets or sets the function to be used to obtain the label for the item. | List | ||
length : uint [read-only]
Gets the number of items in the data provider. | SelectableList | ||
loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | ||
mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | ||
maxHorizontalScrollPosition : Number [override]
Gets or sets the number of pixels that the list scrolls to the right when the
horizontalScrollPolicy property is set to ScrollPolicy.ON. | SelectableList | ||
maxVerticalScrollPosition : Number [read-only]
Gets the maximum vertical scroll position for the current content, in pixels. | BaseScrollPane | ||
mouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer | ||
mouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject | ||
mouseFocusEnabled : Boolean
Gets or sets a value that indicates whether the component can receive focus after
the user clicks it. | UIComponent | ||
mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject | ||
mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject | ||
name : String
Indicates the instance name of the DisplayObject. | DisplayObject | ||
needsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display
when this InteractiveObject instance receives focus. | InteractiveObject | ||
numChildren : int [read-only]
Returns the number of children of this object. | DisplayObjectContainer | ||
opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | ||
parent : DisplayObjectContainer [read-only]
Indicates the DisplayObjectContainer object that contains this display object. | DisplayObject | ||
prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | ||
root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | ||
rotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | DisplayObject | ||
rotationX : Number
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | ||
rotationY : Number
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | ||
rotationZ : Number
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | ||
rowCount : uint [override]
Gets or sets the number of rows that are at least partially visible in the
list. | List | ||
rowHeight : Number
Gets or sets the height of each row in the list, in pixels. | List | ||
scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | ||
scaleX : Number [override]
Multiplies the current width of the component by a scale factor. | UIComponent | ||
scaleY : Number [override]
Multiplies the current height of the component by a scale factor. | UIComponent | ||
scaleZ : Number
Indicates the depth scale (percentage) of an object as applied from the registration point of the object. | DisplayObject | ||
scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | ||
selectable : Boolean
Gets or sets a Boolean value that indicates whether the items in the list
can be selected. | SelectableList | ||
selectedIndex : int
Gets or sets the index of the item that is selected in a single-selection
list. | SelectableList | ||
selectedIndices : Array
Gets or sets an array that contains the items that were selected from
a multiple-selection list. | SelectableList | ||
selectedItem : Object
Gets or sets the item that was selected from a single-selection list. | SelectableList | ||
selectedItems : Array
Gets or sets an array that contains the objects for the
items that were selected from the multiple-selection list. | SelectableList | ||
softKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed. | InteractiveObject | ||
soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | ||
stage : Stage [read-only]
The Stage of the display object. | DisplayObject | ||
tabChildren : Boolean
Determines whether the children of the object are tab enabled. | DisplayObjectContainer | ||
tabEnabled : Boolean
Specifies whether this object is in the tab order. | InteractiveObject | ||
tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | ||
textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | ||
transform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | DisplayObject | ||
useBitmapScrolling : Boolean
When set to true, the cacheAsBitmap property for the scrolling content is set
to true; when set to false this value is turned off. | BaseScrollPane | ||
useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls
over a sprite in which the buttonMode property is set to true. | Sprite | ||
verticalLineScrollSize : Number
Gets or sets a value that describes how many pixels to scroll vertically when a scroll arrow is clicked. | BaseScrollPane | ||
verticalPageScrollSize : Number
Gets or sets the count of pixels by which to move the scroll thumb
on the vertical scroll bar when the scroll bar track is pressed. | BaseScrollPane | ||
verticalScrollBar : ScrollBar [read-only]
Gets a reference to the vertical scroll bar. | BaseScrollPane | ||
verticalScrollPolicy : String
Gets or sets a value that indicates the state of the vertical scroll
bar. | BaseScrollPane | ||
verticalScrollPosition : Number
Gets or sets a value that describes the vertical position of the
vertical scroll bar in the scroll pane, in pixels. | BaseScrollPane | ||
visible : Boolean [override]
Gets or sets a value that indicates whether the current component instance is visible. | UIComponent | ||
width : Number [override]
Gets or sets the width of the component, in pixels. | UIComponent | ||
x : Number [override]
Gets or sets the x coordinate that represents the position of the component along
the x axis within its parent container. | UIComponent | ||
y : Number [override]
Gets or sets the y coordinate that represents the position of the component along
the y axis within its parent container. | UIComponent | ||
z : Number
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | DisplayObject |
Method | Defined By | ||
---|---|---|---|
List()
Creates a new List component instance. | List | ||
Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer | ||
Adds a child DisplayObject instance to this DisplayObjectContainer
instance. | DisplayObjectContainer | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | ||
Appends an item to the end of the list of items. | SelectableList | ||
Inserts an item into the list at the specified index location. | SelectableList | ||
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point. | DisplayObjectContainer | ||
Clears a style that is set on the renderers in the list. | SelectableList | ||
Clears the currently selected item in the list and sets the selectedIndex property to -1. | SelectableList | ||
Deletes a style property from this component instance. | UIComponent | ||
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | ||
Dispatches an event into the event flow. | EventDispatcher | ||
Shows or hides the focus indicator on this component. | UIComponent | ||
Initiates an immediate draw operation, without invalidating everything as invalidateNow does. | UIComponent | ||
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | ||
Returns the child display object instance that exists at the specified index. | DisplayObjectContainer | ||
Returns the child display object that exists with the specified name. | DisplayObjectContainer | ||
Returns the index position of a child DisplayObject instance. | DisplayObjectContainer | ||
Retrieves the object that currently has focus. | UIComponent | ||
Retrieves the item at the specified index. | SelectableList | ||
Returns the index of the next item in the dataProvider in which
the label's first character matches a specified string character. | SelectableList | ||
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | ||
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | ||
Retrieves a style that is set on the renderers in the list. | SelectableList | ||
Retrieves a style property that is set in the style lookup
chain of the component. | UIComponent | ||
[static]
Retrieves the default style map for the current component. | List | ||
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | ||
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | ||
Indicates whether an object has a specified property defined. | Object | ||
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | DisplayObject | ||
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | ||
Marks a property as invalid and redraws the component on the
next frame unless otherwise specified. | UIComponent | ||
Invalidates a specific item renderer. | SelectableList | ||
Invalidates the renderer for the item at the specified index. | SelectableList | ||
Invalidates the whole list, forcing the list items to be redrawn. | SelectableList | ||
Checks whether the specified item is selected in the list. | SelectableList | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Retrieves the ICellRenderer for a given item object, if there is one. | SelectableList | ||
[override]
Retrieves the string that the renderer displays for the given data object
based on the labelField and labelFunction properties. | List | ||
Converts a three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | ||
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | ||
[static]
Merges the styles from multiple classes into one object. | UIComponent | ||
Moves the component to the specified position within its parent. | UIComponent | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Removes all items from the list. | SelectableList | ||
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | ||
Removes a child DisplayObject from the specified index position in the child list of
the DisplayObjectContainer. | DisplayObjectContainer | ||
Removes one or more child DisplayObject instances from the DisplayObjectContainer instance. | DisplayObjectContainer | ||
Removes a listener from the EventDispatcher object. | EventDispatcher | ||
Removes the specified item from the list. | SelectableList | ||
Removes the item at the specified index position. | SelectableList | ||
Replaces the item at the specified index location with another item. | SelectableList | ||
Raises a virtual keyboard. | InteractiveObject | ||
[override]
Scrolls the list to the item at the specified index. | List | ||
Scrolls the list to the item at the location indicated by
the current value of the selectedIndex property. | SelectableList | ||
Changes the position of an existing child in the display object container. | DisplayObjectContainer | ||
Sets the focus to this component. | UIComponent | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
Sets a style on the renderers in the list. | SelectableList | ||
Sets the component to the specified width and height. | UIComponent | ||
Sets a style property on this component instance. | UIComponent | ||
Sorts the elements of the current data provider. | SelectableList | ||
Sorts the elements of the current data provider by one or more
of its fields. | SelectableList | ||
Lets the user drag the specified sprite. | Sprite | ||
Lets the user drag the specified sprite on a touch-enabled device. | Sprite | ||
Ends the startDrag() method. | Sprite | ||
Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite | ||
Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer | ||
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list. | DisplayObjectContainer | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
Returns the string representation of the specified object. | Object | ||
Validates and updates the properties and layout of this object, redrawing it
if necessary. | UIComponent | ||
Returns the primitive value of the specified object. | Object | ||
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher |
Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.
iconField | property |
iconField:String
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS3 |
Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
Gets or sets the item field that provides the icon for the item.
Note: The iconField
is not used
if the iconFunction
property is set to a callback function.
The default value is "icon".
Implementation
public function get iconField():String
public function set iconField(value:String):void
Example ( How to use this example )
RedBox
must exist in the library and have "Export for ActionScript"
toggled in its symbol properties:
import fl.data.DataProvider; import fl.controls.List; var dp:DataProvider = new DataProvider(); dp.addItem( { iconSource:RedBox, label:"Item 1" } ); dp.addItem( { iconSource:RedBox, label:"Item 2" } ); dp.addItem( { iconSource:RedBox, label:"Item 3" } ); var list:List = new List(); list.iconField = "iconSource"; list.dataProvider = dp; addChild(list);
iconFunction | property |
iconFunction:Function
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS3 |
Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
Gets or sets the function to be used to obtain the icon for the item.
Note: The iconField
is not used
if the iconFunction
property is set to a callback function.
The default value is null.
Implementation
public function get iconFunction():Function
public function set iconFunction(value:Function):void
Example ( How to use this example )
iconFunction
property to provide an icon to
a limited number of items in a list. A symbol named RedBox
must exist in
the library and have "Export for ActionScript" toggled in its symbol properties
for this example to function correctly:
import fl.data.DataProvider; import fl.controls.List; var dp:DataProvider = new DataProvider(); dp.addItem( { label:"Item 1" } ); dp.addItem( { label:"Item 2" } ); dp.addItem( { label:"Item 3" } ); var list:List = new List(); list.iconFunction = determineIcon; list.dataProvider = dp; addChild(list); function determineIcon(item:Object):String { if(item.label == "Item 2") { return "RedBox"; } else { return null; } }
labelField | property |
labelField:String
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS3 |
Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
Gets or sets the name of the field in the dataProvider
object
to be displayed as the label for the TextInput field and drop-down list.
By default, the component displays the label
property
of each dataProvider
item. If the dataProvider
items do not contain a label
property, you can set the
labelField
property to use a different property.
Note: The labelField
property is not used
if the labelFunction
property is set to a callback function.
The default value is "label".
Implementation
public function get labelField():String
public function set labelField(value:String):void
Related API Elements
Example ( How to use this example )
abbreviatedLabel
property rather than the default label
property:
import fl.data.DataProvider; import fl.controls.List; var dp:DataProvider = new DataProvider(); dp.addItem( { abbreviatedLabel:"NY", label:"New York" } ); dp.addItem( { abbreviatedLabel:"CA", label:"California" } ); dp.addItem( { abbreviatedLabel:"WA", label:"Washington" } ); dp.addItem( { abbreviatedLabel:"CT", label:"Connecticut" } ); dp.addItem( { abbreviatedLabel:"VT", label:"Vermont" } ); var list:List = new List(); list.setSize(40,100); list.labelField = "abbreviatedLabel" list.dataProvider = dp; addChild(list);
labelFunction | property |
labelFunction:Function
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS3 |
Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
Gets or sets the function to be used to obtain the label for the item.
By default, the component displays the label
property
for a dataProvider
item. But some data sets may not have
a label
field or may not have a field whose value
can be used as a label without modification. For example, a given data
set might store full names but maintain them in lastName
and
firstName
fields. In such a case, this property could be
used to set a callback function that concatenates the values of the
lastName
and firstName
fields into a full
name string to be displayed.
Note: The labelField
property is not used
if the labelFunction
property is set to a callback function.
The default value is null.
Implementation
public function get labelFunction():Function
public function set labelFunction(value:Function):void
Example ( How to use this example )
labelFunction
property of a list to a function that formats the string to be displayed in each cell:
import fl.data.DataProvider; import fl.controls.List; var myDataProvider:DataProvider = new DataProvider(); myDataProvider.addItem({name:"User A", price:0.43}); myDataProvider.addItem({name:"User B", price:0.34}); var users:List = new List(); users.dataProvider = myDataProvider; users.labelFunction = myLabelFunction; addChild(users); function myLabelFunction(item:Object):String { return item.name + " ($" + item.price.toFixed(2) + ")"; }
rowCount | property |
rowCount:uint
[override] Language Version: | ActionScript 3.0 |
Product Version: | Flash CS3 |
Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
Gets or sets the number of rows that are at least partially visible in the list.
Implementation
override public function get rowCount():uint
override public function set rowCount(value:uint):void
Example ( How to use this example )
rowCount
property:
import fl.data.DataProvider; import fl.controls.List; var dp:DataProvider = new DataProvider(); var i:uint; for(i=0; i<100; i++) { dp.addItem( { label: "Item " + i } ); } var list:List = new List(); list.setSize(100,300); list.dataProvider = dp; addChild(list); trace(list.rowCount); // 15
rowCount
based on the current value of a slider:
import fl.controls.Slider; import fl.controls.List; import fl.data.DataProvider; import fl.events.SliderEvent; var dp:DataProvider = new DataProvider(); var i:int; for (i=0; i<8; i++) { dp.addItem({label:"Item " + i}); } var mySlider:Slider = new Slider(); mySlider.move(10, 10); mySlider.tickInterval = 1; mySlider.snapInterval = 1; mySlider.minimum = 2; mySlider.maximum = 9; mySlider.liveDragging = true; mySlider.addEventListener(SliderEvent.CHANGE, changeHandler); addChild(mySlider); var myList:List = new List(); myList.dataProvider = dp; myList.move(mySlider.x, mySlider.y + 20); myList.setSize(100, 50); addChild(myList); function changeHandler(event:SliderEvent):void { myList.rowCount = event.value; }
rowHeight | property |
rowHeight:Number
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS3 |
Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
Gets or sets the height of each row in the list, in pixels.
The default value is 20.
Implementation
public function get rowHeight():Number
public function set rowHeight(value:Number):void
List | () | Constructor |
public function List()
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS3 |
Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
Creates a new List component instance.
getStyleDefinition | () | method |
public static function getStyleDefinition():Object
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS3 |
Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
Retrieves the default style map for the current component. The style map contains
the type that is appropriate for the component, depending on the style that
the component uses. For example, the disabledTextFormat
style
contains a value of null
or a TextFormat object.
You can use these styles and call setStyle()
on the current
component. The following code overrides the default disabledTextFormat
style on the specified component:
componentInstance.setStyle("disabledTextFormat", new TextFormat());
Object — Default styles object.
|
Related API Elements
Example ( How to use this example )
import fl.controls.*; import fl.containers.*; import fl.controls.listClasses.*; import fl.controls.dataGridClasses.*; import fl.controls.progressBarClasses.*; import fl.core.UIComponent; import fl.data.DataProvider; var dp:DataProvider = new DataProvider(); dp.addItem( { label: "BaseScrollPane", data:BaseScrollPane } ); dp.addItem( { label: "Button", data:Button } ); dp.addItem( { label: "CellRenderer", data:CellRenderer } ); dp.addItem( { label: "CheckBox", data:CheckBox } ); dp.addItem( { label: "ColorPicker", data:ColorPicker } ); dp.addItem( { label: "ComboBox", data:ComboBox } ); dp.addItem( { label: "DataGrid", data:DataGrid } ); dp.addItem( { label: "HeaderRenderer", data:HeaderRenderer } ); dp.addItem( { label: "ImageCell", data:ImageCell } ); dp.addItem( { label: "IndeterminateBar",data:IndeterminateBar } ); dp.addItem( { label: "Label", data:Label } ); dp.addItem( { label: "List", data:List } ); dp.addItem( { label: "NumericStepper", data:NumericStepper } ); dp.addItem( { label: "ProgressBar", data:ProgressBar } ); dp.addItem( { label: "RadioButton", data:RadioButton } ); dp.addItem( { label: "ScrollPane", data:ScrollPane } ); dp.addItem( { label: "Slider", data:Slider } ); dp.addItem( { label: "TextArea", data:TextArea } ); dp.addItem( { label: "TextInput", data:TextInput } ); dp.addItem( { label: "TileList", data:TileList } ); dp.addItem( { label: "UILoader", data:UILoader } ); dp.addItem( { label: "UIComponent", data:UIComponent } ); var cb:ComboBox = new ComboBox(); cb.move(10,10); cb.setSize(300,25); cb.prompt = "Select a component to view its styles"; cb.rowCount = 12; cb.dataProvider = dp; cb.addEventListener(Event.CHANGE, showStyleDefinition); addChild(cb); var dg:DataGrid = new DataGrid(); dg.setSize(425,300); dg.move(10,50); dg.columns = [ new DataGridColumn("StyleName"), new DataGridColumn("DefaultValue") ]; addChild(dg); function showStyleDefinition(e:Event):void { var componentClass:Class = e.target.selectedItem.data as Class; var styles:Object = componentClass["getStyleDefinition"].call(this); trace(styles.toString()); var styleData:DataProvider = new DataProvider(); for(var i:* in styles) { trace(i + " : " + styles[i]); styleData.addItem( { StyleName:i, DefaultValue:styles[i] } ); } styleData.sortOn("StyleName"); dg.dataProvider = styleData; }
itemToLabel | () | method |
override public function itemToLabel(item:Object):String
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS3 |
Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
Retrieves the string that the renderer displays for the given data object
based on the labelField
and labelFunction
properties.
Note: The labelField
is not used
if the labelFunction
property is set to a callback function.
Parameters
item:Object — The object to be rendered.
|
String — The string to be displayed based on the data.
|
Example ( How to use this example )
import fl.controls.List; import fl.data.DataProvider; import fl.events.ListEvent; var myDataProvider:DataProvider = new DataProvider(); myDataProvider.addItem({label:"Carrot", price:0.43}); myDataProvider.addItem({label:"Tomato", price:0.34}); myDataProvider.addItem({label:"Blueberry", price:0.72}); myDataProvider.addItem({label:"Turnip", price:0.24}); var myList:List = new List(); myList.setSize(300,80); myList.dataProvider = myDataProvider; myList.labelFunction = myLabelFunction; myList.addEventListener(ListEvent.ITEM_ROLL_OVER, announceLabel); addChild(myList); function myLabelFunction(item:Object):String { return item.label + " - Current price: ($" + item.price.toFixed(2) + ")"; } function announceLabel(e:ListEvent):void { var list:List = e.target as List; var item:Object = e.item; trace("Label: " + item.label); trace("Label displayed: " + list.itemToLabel(item)); }
scrollToIndex | () | method |
override public function scrollToIndex(newCaretIndex:int):void
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS3 |
Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
Scrolls the list to the item at the specified index. If the index is out of range, the scroll position does not change.
Parameters
newCaretIndex:int — The index location to scroll to.
|
- Add the List, Button, and Label classes to the library.
- Save this code as ListExample.as in the same directory as your FLA.
- Set the DocumentClass in the FLA to ListExample.
package { import flash.display.Sprite public class ListExample extends Sprite { import flash.events.*; import fl.data.DataProvider; import fl.controls.List import fl.controls.Label import fl.controls.Button private var clearButton:Button; private var availableItems:List; private var selectedItemList:List; private var selectedItemsList:List; public function ListExample() { createComponents(); setupComponents(); } private function setupComponents():void { var dp:Array = new Array(); var i:uint; var count:uint = availableItems.rowCount * 2; for (i = 0; i < count; i++) { dp.push({label:"Item " + i}); } availableItems.allowMultipleSelection = true; availableItems.dataProvider = new DataProvider(dp); availableItems.dataProvider = new DataProvider(dp); availableItems.addEventListener(Event.CHANGE, updateLists); clearButton.addEventListener(MouseEvent.CLICK, clearHandler); } private function clearHandler(event:MouseEvent):void { availableItems.clearSelection(); // clear data providers selectedItemList.dataProvider = new DataProvider(); selectedItemsList.dataProvider = new DataProvider(); } private function updateLists(e:Event):void { selectedItemList.dataProvider = availableItems.selectedItem ? new DataProvider([availableItems.selectedItem]) : new DataProvider(); selectedItemsList.dataProvider = new DataProvider(availableItems.selectedItems); } private function createComponents():void { clearButton = new Button(); availableItems = new List(); selectedItemList = new List(); selectedItemsList = new List(); var availableItemsLabel:Label = new Label(); var selectedItemListLabel:Label = new Label(); var selectedItemsListLabel:Label = new Label(); clearButton.move(10,142); availableItems.move(10,32); selectedItemList.move(120,32); selectedItemsList.move(230,32); availableItemsLabel.move(10,10); selectedItemListLabel.move(120,10); selectedItemsListLabel.move(230,10); clearButton.label = "Clear Selection" availableItemsLabel.text = "Available Items"; selectedItemListLabel.text = "Selected Item"; selectedItemsListLabel.text = "All Selected Items"; addChild(clearButton); addChild(availableItems); addChild(selectedItemList); addChild(selectedItemsList); addChild(availableItemsLabel); addChild(selectedItemListLabel); addChild(selectedItemsListLabel); } } }
Mon Nov 28 2011, 06:48 AM -08:00