| Package | spark.components |
| Class | public class List |
| Inheritance | List  ListBase SkinnableDataContainer SkinnableContainerBase SkinnableComponent UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implements | IFocusManagerComponent |
| Subclasses | DropDownListBase |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
allowMultipleSelection property.
Note: The Spark list-based controls (the Spark ListBase class and its subclasses
such as ButtonBar, ComboBox, DropDownList, List, and TabBar) do not support the BasicLayout class
as the value of the layout property.
Do not use BasicLayout with the Spark list-based controls.
The List control has the following default characteristics:
| Characteristic | Description |
|---|---|
| Default size | 112 pixels wide by 112 pixels high |
| Minimum size | 112 pixels wide by 112 pixels high |
| Maximum size | 10000 pixels wide and 10000 pixels high |
| Default skin class | spark.skins.spark.BorderContainerSkin |
Show MXML Syntax
Hide MXML SyntaxThe <s:List> tag inherits all of the tag
attributes of its superclass and adds the following tag attributes:
<s:List
Properties
allowMultipleSelection="false"
dragEnabled="false"
dragMoveEnabled="false"
dropEnabled="false"
selectedIndices="null"
selectedItems="null"
useVirtualLayout="true"
Styles
alternatingItemColors="undefined"
borderAlpha="1.0"
borderColor="0#CCCCCC"
borderVisible="true"
contentBackgroundColor="0xFFFFFF"
dragIndicator="ListItemDragProxy"
dropIndicatorSkin="ListDropIndicator"
rollOverColor="0xCEDBEF"
selectionColor="0xA8C6EE"
symbolColor="0x000000"
/>
Default MXML PropertydataProvider
See also
spark.skins.spark.ListSkin
Define a custom Spark item renderer
Using Spark list-based controls
Spark List control
Define a custom Spark item renderer
Using Spark list-based controls
Spark List control
Public Properties
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityDescription : String
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityEnabled : Boolean
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | |
| accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | |
| accessibilityShortcut : String
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| activeEffects : Array [read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances. | UIComponent | |
| allowMultipleSelection : Boolean
If true multiple selection is enabled. | List | ||
| alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | |
| arrowKeysWrapFocus : Boolean
If true, using arrow keys to navigate within
the component wraps when it hits either end. | ListBase | |
| autoLayout : Boolean
If true, measurement and layout are done
when the position or size of a child is changed. | SkinnableDataContainer | |
| automationDelegate : Object
The delegate object that handles the automation-related functionality. | UIComponent | |
| automationEnabled : Boolean [read-only]
True if this component is enabled for automation, false
otherwise. | UIComponent | |
| automationName : String
Name that can be used as an identifier for this object. | UIComponent | |
| automationOwner : DisplayObjectContainer [read-only]
The owner of this component for automation purposes. | UIComponent | |
| automationParent : DisplayObjectContainer [read-only]
The parent of this component for automation purposes. | UIComponent | |
| automationTabularData : Object [read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | |
| automationValue : Array [read-only]
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application. | UIComponent | |
| automationVisible : Boolean [read-only]
True if this component is visible for automation, false
otherwise. | UIComponent | |
| baseline : Object
The vertical distance in pixels from the anchor target to
the control's baseline position. | UIComponent | |
| baselinePosition : Number [override] [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | SkinnableComponent | |
| 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 | |
| bottom : Object
The vertical distance in pixels from the bottom edge of the component to the
anchor target's bottom edge. | UIComponent | |
| buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | |
| cacheAsBitmap : Boolean
If set to true, Flash Player or Adobe AIR caches an internal bitmap representation of the
display object. | DisplayObject | |
| cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object. | UIComponent | |
| caretIndex : Number [read-only]
Item that is currently in focus. | ListBase | |
| className : String [read-only]
The name of this instance's class, such as "Button". | UIComponent | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| contentMouseX : Number [read-only]
Returns the x position of the mouse, in the content coordinate system. | UIComponent | |
| contentMouseY : Number [read-only]
Returns the y position of the mouse, in the content coordinate system. | UIComponent | |
| contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | |
| currentState : String
The current view state of the component. | UIComponent | |
| cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers. | UIComponent | |
| dataProvider : IList
The data provider for this DataGroup. | SkinnableDataContainer | |
| defaultButton : IFlexDisplayObject
The Button control designated as the default button for the container. | SkinnableContainerBase | |
| depth : Number
Determines the order in which items inside of containers
are rendered. | UIComponent | |
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
| designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | UIComponent | |
| document : Object
A reference to the document object associated with this UIComponent. | UIComponent | |
| doubleClickEnabled : Boolean [override]
Specifies whether the UIComponent object receives doubleClick events. | UIComponent | |
| dragEnabled : Boolean
A flag that indicates whether you can drag items out of
this control and drop them on other controls. | List | ||
| dragMoveEnabled : Boolean
A flag that indicates whether items can be moved instead
of just copied from the control as part of a drag-and-drop
operation. | List | ||
| dropEnabled : Boolean
A flag that indicates whether dragged items can be dropped onto the
control. | List | ||
| 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
Whether the component can accept user interaction. | UIComponent | |
| errorString : String
The text that displayed by a component's error tip when a
component is monitored by a Validator and validation fails. | UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | UIComponent | |
| explicitMaxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | UIComponent | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent. | UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to. | UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers. | UIComponent | |
| focusPane : Sprite
The focus pane associated with this object. | 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 | |
| hasFocusableChildren : Boolean [override]
A flag that indicates whether this List's focusable item renderers
can take keyboard focus. | List | ||
| hasLayoutMatrix3D : Boolean [read-only]
Contians true if the element has 3D Matrix. | UIComponent | |
| height : Number [override]
Number that specifies the height of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| horizontalCenter : Object
The horizontal distance in pixels from the center of the component to the
center of the anchor target's content area. | UIComponent | |
| id : String
ID of the component. | UIComponent | |
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container. | UIComponent | |
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles. | UIComponent | |
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required). | UIComponent | |
| instanceIndex : int [read-only]
The index of a repeated component. | UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document. | UIComponent | |
| is3D : Boolean [read-only]
Contains true when the element is in 3D. | UIComponent | |
| isDocument : Boolean [read-only]
Contains true if this UIComponent instance is a document object. | UIComponent | |
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | UIComponent | |
| itemRenderer : IFactory
The item renderer to use for data items. | SkinnableDataContainer | |
| itemRendererFunction : Function
Function that returns an item renderer IFactory for a
specific item. | SkinnableDataContainer | |
| labelField : String
The name of the field in the data provider items to display
as the label. | ListBase | |
| labelFunction : Function
A user-supplied function to run on each item to determine its label. | ListBase | |
| layout : LayoutBase
The layout object for this container. | SkinnableDataContainer | |
| layoutMatrix3D : Matrix3D [write-only]
The transform matrix that is used to calculate a component's layout
relative to its siblings. | UIComponent | |
| left : Object
The horizontal distance in pixels from the left edge of the component to the
anchor target's left edge. | UIComponent | |
| loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | |
| maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | |
| mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | |
| maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| maxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels. | UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels. | UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels. | UIComponent | |
| measuredWidth : Number
The default width of the component, in pixels. | UIComponent | |
| minHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| minWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| moduleFactory : IFlexModuleFactory
A module factory is used as context for using embedded fonts and for
finding the style manager that controls the styles for this
component. | UIComponent | |
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled. | DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse messages. | InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| mouseX : Number [read-only]
Indicates the x coordinate of the mouse position, in pixels. | DisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse position, in pixels. | DisplayObject | |
| name : String
Indicates the instance name of the DisplayObject. | DisplayObject | |
| nestLevel : int
Depth of this object in the containment hierarchy. | UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles. | UIComponent | |
| numAutomationChildren : int [read-only]
The number of automation children this container has. | UIComponent | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | |
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | UIComponent | |
| parent : DisplayObjectContainer [override] [read-only]
The parent container or component for this component. | UIComponent | |
| parentApplication : Object [read-only]
A reference to the Application object that contains this UIComponent
instance. | UIComponent | |
| parentDocument : Object [read-only]
A reference to the parent document object for this UIComponent. | UIComponent | |
| percentHeight : Number
Number that specifies the height of a component as a percentage
of its parent's size. | UIComponent | |
| percentWidth : Number
Number that specifies the width of a component as a percentage
of its parent's size. | UIComponent | |
| postLayoutTransformOffsets : mx.geom:TransformOffsets
Defines a set of adjustments that can be applied to the object's
transform in a way that is invisible to its parent's layout. | UIComponent | |
| processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| repeater : IRepeater [read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent. | UIComponent | |
| repeaterIndex : int [read-only]
The index of the item in the data provider
of the Repeater that produced this UIComponent. | UIComponent | |
| repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent. | UIComponent | |
| repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent. | UIComponent | |
| requireSelection : Boolean
If true, a data item must always be selected in the control. | ListBase | |
| right : Object
The horizontal distance in pixels from the right edge of the component to the
anchor target's right edge. | UIComponent | |
| 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 [override]
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | UIComponent | |
| rotationX : Number [override]
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationY : Number [override]
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationZ : Number [override]
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent | |
| scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | |
| scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIComponent | |
| scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIComponent | |
| scaleZ : Number [override]
Number that specifies the scaling factor along the z axis. | UIComponent | |
| screen : Rectangle [read-only]
Returns an object that contains the size and position of the base
drawing surface for this object. | UIComponent | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | |
| selectedIndex : int
The 0-based index of the selected item, or -1 if no item is selected. | ListBase | |
| selectedIndices : Vector.<int>
A Vector of ints representing the indices of the currently selected
item or items. | List | ||
| selectedItem : *
The item that is currently selected. | ListBase | |
| selectedItems : Vector.<Object>
A Vector of Objects representing the currently selected data items. | List | ||
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | |
| skin : UIComponent [read-only]
The instance of the skin class for this component instance. | SkinnableComponent | |
| soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | |
| stage : Stage [read-only]
The Stage of the display object. | DisplayObject | |
| states : Array
The view states that are defined for this component. | UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object. | UIComponent | |
| styleManager : IStyleManager2 [read-only]
Returns the StyleManager instance used by this component. | UIComponent | |
| styleName : Object
The class style used by this component. | UIComponent | |
| styleParent : IAdvancedStyleClient [read-only]
A component's parent is used to evaluate descendant selectors. | UIComponent | |
| suggestedFocusSkinExclusions : Array [read-only]
Lists the skin parts that are
excluded from bitmaps captured and used to
show focus. | SkinnableComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component. | UIComponent | |
| 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 | |
| tabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus
via the TAB key
This is similar to the tabEnabled property
used by the Flash Player.
This is usually true for components that
handle keyboard input, but some components in controlbars
have them set to false because they should not steal
focus from another component like an editor. | UIComponent | |
| 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 | |
| toolTip : String
Text to display in the ToolTip. | UIComponent | |
| top : Object
The vertical distance in pixels from the top edge of the component to the
anchor target's top edge. | UIComponent | |
| transform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | DisplayObject | |
| transformX : Number
Sets the x coordinate for the transform center of the component. | UIComponent | |
| transformY : Number
Sets the y coordinate for the transform center of the component. | UIComponent | |
| transformZ : Number
Sets the z coordinate for the transform center of the component. | UIComponent | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | |
| tweeningProperties : Array
Array of properties that are currently being tweened on this object. | UIComponent | |
| typicalItem : Object
Layouts use the preferred size of the typicalItem
when fixed row or column sizes are required, but a specific
rowHeight or columnWidth value is not set. | SkinnableDataContainer | |
| uid : String
A unique identifier for the object. | UIComponent | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required). | UIComponent | |
| useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the mouse rolls
over a sprite in which the buttonMode property is set to true. | Sprite | |
| useVirtualLayout : Boolean [override]
Sets the value of the useVirtualLayout property
of the layout associated with this control. | List | ||
| validationSubField : String
Used by a validator to associate a subfield with this component. | UIComponent | |
| verticalCenter : Object
The vertical distance in pixels from the center of the component to the
center of the anchor target's content area. | UIComponent | |
| visible : Boolean [override]
Whether or not the display object is visible. | UIComponent | |
| width : Number [override]
Number that specifies the width of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| x : Number [override]
Number that specifies the component's horizontal position,
in pixels, within its parent container. | UIComponent | |
| y : Number [override]
Number that specifies the component's vertical position,
in pixels, within its parent container. | UIComponent | |
| z : Number [override]
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | UIComponent | |
Protected Properties
Public Methods
| Method | Defined By | ||
|---|---|---|---|
List()
Constructor. | List | ||
Adds the selected items to the DragSource object as part of
a drag-and-drop operation. | List | ||
| 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 | |
|
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 | |
|
Queues a function to be called later. | UIComponent | |
|
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 | |
|
Converts a Point object from content coordinates to global coordinates. | UIComponent | |
|
Converts a Point object from content to local coordinates. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
Creates an instance of a class that is used to display the visuals
of the dragged items during a drag and drop operation. | List | ||
Creates and instance of the dropIndicator class that is used to
display the visuals of the drop location during a drag and drop
operation. | List | ||
|
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
Releases the dropIndicator instance that is currently set in the layout. | List | ||
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | |
| [override]
Dispatches an event into the event flow. | UIComponent | |
|
Shows or hides the focus indicator around this component. | UIComponent | |
| drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object. | UIComponent | |
|
Called by the effect instance when it stops playing on the component. | UIComponent | |
|
Called by the effect instance when it starts playing on the component. | UIComponent | |
|
Ends all currently playing effects on the component. | UIComponent | |
A convenience method that handles scrolling a data item
into view. | List | ||
|
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | |
|
Called after printing is complete. | UIComponent | |
|
Provides the automation object at the specified index. | UIComponent | |
|
Provides the automation object list . | UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
|
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the child display object that exists with the specified name. | DisplayObjectContainer | |
|
Finds the type selectors for this UIComponent instance. | UIComponent | |
|
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
Gets the object that currently has focus. | UIComponent | |
|
Returns the element's layout height. | UIComponent | |
|
Returns the element's layout width. | UIComponent | |
|
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
|
Returns the layout transform Matrix3D for this element. | UIComponent | |
|
Returns the element's maximum height. | UIComponent | |
|
Returns the element's maximum width. | UIComponent | |
|
Returns the element's minimum height. | UIComponent | |
|
Returns the element's minimum width. | UIComponent | |
|
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 the element's preferred height. | UIComponent | |
|
Returns the element's preferred width. | UIComponent | |
|
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 | |
|
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
|
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
|
Converts a Point object from global to content coordinates. | UIComponent | |
|
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 | |
|
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
|
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 | |
|
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
|
Initializes the internal structure of this component. | UIComponent | |
|
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
|
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
|
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
|
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
|
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
|
Marks the component so that the new state of the skin is set
during a later screen update. | SkinnableComponent | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
| [override]
Given a data item, return the correct text a renderer
should display while taking the labelField
and labelFunction properties into account. | ListBase | |
|
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 a Point object from local to content coordinates. | UIComponent | |
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
|
Returns true if cssState matches currentCSSState. | UIComponent | |
|
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | |
|
Measures the specified HTML text, which can contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Measures the specified text, assuming that it is displayed
in a single-line UITextField (or UIFTETextField) using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Moves the component to a specified position within its parent. | UIComponent | |
|
Propagates style changes to the children. | UIComponent | |
|
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
|
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
|
Prepares an IFlexDisplayObject for printing. | UIComponent | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well. | UIComponent | |
|
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Replays the specified event. | UIComponent | |
|
Resolves a child by using the id provided. | UIComponent | |
| [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
|
Sizes the object. | UIComponent | |
|
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
|
Set the current state. | UIComponent | |
|
Sets the focus to this component. | UIComponent | |
|
Sets the coordinates that the element uses to draw on screen. | UIComponent | |
|
Sets the layout size of the element. | UIComponent | |
|
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Sets a style property on this component instance. | UIComponent | |
|
Called when the visible property changes. | UIComponent | |
|
Lets the user drag the specified sprite. | Sprite | |
|
Ends the startDrag() method. | Sprite | |
|
Detects changes to style properties. | UIComponent | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
| transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the
transform while keeping a particular point, specified in the component's
own coordinate space, fixed in the parent's coordinate space. | UIComponent | |
|
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. | UIComponent | |
|
Updates an item renderer for use or reuse. | SkinnableDataContainer | |
|
Validates the position and size of children and draws other
visuals. | UIComponent | |
|
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
|
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
|
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | |
|
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
Returns the primitive value of the specified object. | Object | |
|
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Protected Methods
| Method | Defined By | ||
|---|---|---|---|
|
Adjust the focus rectangle. | UIComponent | |
[override]
Adjusts the selected indices to account for items being added to or
removed from this component. | List | ||
Adjusts the selection based on what keystroke or
keystroke combinations were encountered. | List | ||
|
Commits the computed matrix built from the combination of the layout
matrix and the transform offsets to the flash displayObject's transform. | UIComponent | |
|
This is an internal method used by the Flex framework
to support the Dissolve effect. | UIComponent | |
|
Create the skin for the component. | SkinnableComponent | |
Helper method to calculate how the current selection changes when an item is clicked. | List | ||
|
Determines if the call to the measure() method can be skipped. | UIComponent | |
|
Performs any final processing after child objects are created. | UIComponent | |
|
Clear out references to skin parts. | SkinnableComponent | |
|
Processes the properties set on the component. | UIComponent | |
Makes a deep copy of the object by calling the
ObjectUtil.copy() method, and replaces
the copy's uid property (if present) with a
new value by calling the UIDUtil.createUID() method. | List | ||
|
Create child objects of the component. | UIComponent | |
|
Create an instance of a dynamic skin part. | SkinnableComponent | |
|
Creates a new object using a context
based on the embedded font being used. | UIComponent | |
|
Creates the object using a given moduleFactory. | UIComponent | |
|
Destroys and removes the skin for this component. | SkinnableComponent | |
|
Helper method for dispatching a PropertyChangeEvent
when a property is updated. | UIComponent | |
|
Find the skin parts in the skin class and assign them to the properties of the component. | SkinnableComponent | |
|
The event handler called when a UIComponent object gets focus. | UIComponent | |
|
The event handler called when a UIComponent object loses focus. | UIComponent | |
| [override]
Returns the name of the state to be applied to the skin. | SkinnableContainerBase | |
|
Returns a specific instance of a dynamic part. | SkinnableComponent | |
|
Initializes the implementation and storage of some of the less frequently
used advanced layout features of a component. | UIComponent | |
|
Finalizes the initialization of this component. | UIComponent | |
|
Initializes this component's accessibility code. | UIComponent | |
|
Helper method to invalidate parent size and display list if
this object affects its layout (includeInLayout is true). | UIComponent | |
|
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus. | UIComponent | |
|
Called when an item has been added to this component. | ListBase | |
|
Called when an item has been removed from this component. | ListBase | |
|
Called when an item is selected or deselected. | ListBase | |
|
Called when an item is in its caret state or not. | ListBase | |
|
The event handler called for a keyDown event. | UIComponent | |
|
The event handler called for a keyUp event. | UIComponent | |
|
Calculates the default size, and optionally the default minimum size,
of the component. | UIComponent | |
|
Returns the number of instances of a dynamic part. | SkinnableComponent | |
|
Called when a skin part is added. | SkinnableComponent | |
|
Called when an instance of a skin part is being removed. | SkinnableComponent | |
|
Remove an instance of a dynamic part. | SkinnableComponent | |
|
This method is called when a UIComponent is constructed,
and again whenever the ResourceManager dispatches
a "change" Event to indicate
that the localized resources have changed in some way. | UIComponent | |
|
Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent | |
|
This method is called when a state changes to check whether
state-specific styles apply to this component. | UIComponent | |
|
Draws the object and/or sizes and positions its children. | UIComponent | |
Styles
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.
Common Styles
| Style | Description | Defined By | ||
|---|---|---|---|---|
| Type: String CSS Inheritance: yes Specifies the baseline to which the dominant baseline aligns. | SkinnableDataContainer | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | ||
| Type: Object CSS Inheritance: yes Amount to shift the baseline from the dominantBaseline value. | SkinnableDataContainer | ||
| Type: String CSS Inheritance: no The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area. | UIComponent | ||
| Type: String CSS Inheritance: yes The type of CFF hinting used for this text. | SkinnableDataContainer | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the text. | SkinnableDataContainer | ||
| Type: String CSS Inheritance: yes The type of digit case used for this text. | SkinnableDataContainer | ||
| Type: String CSS Inheritance: yes Type of digit width used for this text. | SkinnableDataContainer | ||
| Type: String CSS Inheritance: yes Specifies the default bidirectional embedding level of the text in the text block. | SkinnableDataContainer | ||
| Type: String CSS Inheritance: yes Specifies which element baseline snaps to the alignmentBaseline to determine the vertical position of the element on the line. | SkinnableDataContainer | ||
dragIndicatorClass | Type: Class CSS Inheritance: no The class to create instance of for the drag indicator during drag and drop operations initiated by the List. Must be of type IFlexDisplayObject.
If the class implements the If the class implements the The AIR DragManager takes a snapshot of the instance, while the non-AIR DragManager uses the instance directly. The default value is spark.components.supportClasses.ListItemDragProxy. | List | ||
dropIndicatorSkin | Type: Class CSS Inheritance: no If a dropIndicator skin part is not specified in the List skin,
then an instance of this class is created and used for the default drop
indicator during drag and drop operations where the List is a potential
drop target.
The default value is spark.skins.spark.ListDropIndicator. | List | ||
| Type: Class Name of the skin class to use for this component when a validation error occurs. | SkinnableComponent | ||
| Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent | ||
| Type: String CSS Inheritance: yes The name of the font to use, or a comma-separated list of font names. | SkinnableDataContainer | ||
| Type: String CSS Inheritance: yes Font lookup to use. | SkinnableDataContainer | ||
| Type: Number Format: Length CSS Inheritance: yes The size of the text in pixels. | SkinnableDataContainer | ||
| Type: String CSS Inheritance: yes Style of text. | SkinnableDataContainer | ||
| Type: String CSS Inheritance: yes Weight of text. | SkinnableDataContainer | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
| Type: String CSS Inheritance: yes Rule used to justify text in a paragraph. | SkinnableDataContainer | ||
| Type: String CSS Inheritance: yes The style used for justification of the paragraph. | SkinnableDataContainer | ||
| Type: String CSS Inheritance: yes | SkinnableDataContainer | ||
| Type: String CSS Inheritance: no The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area. | UIComponent | ||
| Type: String CSS Inheritance: yes Controls which of the ligatures that are defined in the font may be used in the text. | SkinnableDataContainer | ||
| Type: Object CSS Inheritance: yes Leading controls for the text. | SkinnableDataContainer | ||
| Type: Boolean CSS Inheritance: yes If true, applies strikethrough, a line drawn through the middle of the text. | SkinnableDataContainer | ||
| Type: String CSS Inheritance: yes The locale of the text. | SkinnableDataContainer | ||
| Type: String CSS Inheritance: yes The rendering mode used for this text. | SkinnableDataContainer | ||
| Type: String CSS Inheritance: no The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area. | UIComponent | ||
| Type: Class Name of the skin class to use for this component. | SkinnableComponent | ||
| Type: String CSS Inheritance: yes Alignment of lines in the paragraph relative to the container. | SkinnableDataContainer | ||
| Type: String CSS Inheritance: yes Alignment of the last (or only) line in the paragraph relative to the container in justified text. | SkinnableDataContainer | ||
| Type: Number CSS Inheritance: yes Alpha (transparency) value for the text. | SkinnableDataContainer | ||
| Type: String CSS Inheritance: yes Decoration on text. | SkinnableDataContainer | ||
| Type: String CSS Inheritance: yes Specifies options for justifying text. | SkinnableDataContainer | ||
| Type: String CSS Inheritance: no The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. | UIComponent | ||
| Type: Object CSS Inheritance: yes Number in pixels (or percent of fontSize, like 120%) indicating the amount of tracking (manual kerning) to be applied to the left of each character. | SkinnableDataContainer | ||
| Type: Object CSS Inheritance: yes Number in pixels (or percent of fontSize, like 120%) indicating the amount of tracking (manual kerning) to be applied to the right of each character. | SkinnableDataContainer | ||
| Type: String CSS Inheritance: yes The type of typographic case used for this text. | SkinnableDataContainer | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
Spark Theme Styles
| Style | Description | Defined By | ||
|---|---|---|---|---|
alternatingItemColors | Type: Array Format: Color CSS Inheritance: yes Theme: spark The colors to use for the backgrounds of the items in the list. The value is an array of two or more colors. The backgrounds of the list items alternate among the colors in the array. The default value is undefined. | List | ||
borderAlpha | Type: Number CSS Inheritance: no Theme: spark The alpha of the border for this component. The default value is 1.0. | List | ||
borderColor | Type: uint Format: Color CSS Inheritance: no Theme: spark The color of the border for this component. The default value is 0#CCCCCC. | List | ||
borderVisible | Type: Boolean CSS Inheritance: no Theme: spark Controls the visibility of the border for this component. The default value is true. | List | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark The main color for a component. | SkinnableComponent | ||
contentBackgroundAlpha | Type: Number CSS Inheritance: yes Theme: spark The alpha of the content background for this component. | List | ||
contentBackgroundColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of the fill of an item renderer. The default value is 0xFFFFFF. | List | ||
| Type: Number CSS Inheritance: no Theme: spark The alpha of the focus ring for this component. | SkinnableDataContainer | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of focus ring when the component is in focus. | SkinnableDataContainer | ||
rollOverColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of the highlights when the mouse is over the component. The default value is 0xCEDBEF. | List | ||
selectionColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark The color of the background of a renderer when the user selects it. The default value for the Halo theme is 0x7FCEFF.
The default value for the Spark theme is 0xA8C6EE.
The default value is 0xA8C6EE. | List | ||
symbolColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of any symbol of a component. Examples include the check mark of a CheckBox or the arrow of a scroll button. The default value is 0x000000. | List | ||
Skin Parts
This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.
| Skin Part | Description | Defined By | ||
|---|---|---|---|---|
| Required: false Part Type: Static An optional skin part that defines the DataGroup in the skin class where data items get pushed into, rendered, and laid out. | SkinnableDataContainer | ||
dropIndicator:IFactory | Required: false Part Type: Dynamic A skin part that defines the appearance of the drop indicator. The drop indicator is resized and positioned by the layout to outline the insert location when dragging over the List. By default, the drop indicator for a Spark control is a solid line that spans the width of the control. Create a custom drop indicator by creating a custom skin class for the drop target. In your skin class, create a skin part named dropIndicator, in the The IFactory must return an object of type DisplayObject. | List | ||
scroller:Scroller | Required: false Part Type: Static The optional Scroller used to scroll the List. | List | ||
Skin States
To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.
Public Constants
Property Detail
allowMultipleSelection | property |
allowMultipleSelection:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
If true multiple selection is enabled.
When switched at run time, the current selection
is cleared.
The default value is false.
Implementation
public function get allowMultipleSelection():Boolean public function set allowMultipleSelection(value:Boolean):voiddragEnabled | property |
dragEnabled:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
A flag that indicates whether you can drag items out of
this control and drop them on other controls.
If true, dragging is enabled for the control.
If the dropEnabled property is also true,
you can drag items and drop them within this control
to reorder the items.
The default value is false.
Implementation
public function get dragEnabled():Boolean public function set dragEnabled(value:Boolean):voiddragMoveEnabled | property |
dragMoveEnabled:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
A flag that indicates whether items can be moved instead
of just copied from the control as part of a drag-and-drop
operation.
If true, and the dragEnabled property
is true, items can be moved.
Often the data provider cannot or should not have items removed
from it, so a MOVE operation should not be allowed during
drag-and-drop.
The default value is false.
Implementation
public function get dragMoveEnabled():Boolean public function set dragMoveEnabled(value:Boolean):voiddropEnabled | property |
dropEnabled:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
A flag that indicates whether dragged items can be dropped onto the control.
If you set this property to true,
the control accepts all data formats, and assumes that
the dragged data matches the format of the data in the data provider.
If you want to explicitly check the data format of the data
being dragged, you must handle one or more of the drag events,
such as dragEnter and dragOver,
and call the DragEvent's preventDefault() method
to customize the way the list class accepts dropped data.
When you set dropEnabled to true,
Flex automatically calls the showDropFeedback()
and hideDropFeedback() methods to display the drop
indicator.
The default value is false.
Implementation
public function get dropEnabled():Boolean public function set dropEnabled(value:Boolean):voidhasFocusableChildren | property |
hasFocusableChildren:Boolean[override] | Language Version: | ActionScript 4.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
A flag that indicates whether this List's focusable item renderers can take keyboard focus.
Note: This property is similar to the tabChildren property
used by Flash Player.
Use the hasFocusableChildren property with Flex applications.
Do not use the tabChildren property.
This property is usually false because most components
either receive focus themselves or delegate focus to a single
internal sub-component and appear as if the component has
received focus. You may choose to set this to true on a List
such that the contents within your List become focusable.
If set, and the List skin contains a Scroller skin part, the value is proxied down onto the Scroller.
If the value is true, this proxying means that
the contents of the Scroller, like item renderers, are now
focusable. For example, this means the first tab keystroke will
put focus on the List control, and the second tab keystroke will
put focus on the first focusable child of the Scroller.
If false, the first tab keystroke will put focus
on the List control and the second tab keystroke will move focus
to the next focusable control after the List.
The default value is false.
Implementation
override public function get hasFocusableChildren():Boolean override public function set hasFocusableChildren(value:Boolean):voidselectedIndices | property |
selectedIndices:Vector.<int>| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
A Vector of ints representing the indices of the currently selected
item or items.
If multiple selection is disabled by setting
allowMultipleSelection to false, and this property
is set, the data item corresponding to the first index in the Vector is selected.
If multiple selection is enabled by setting
allowMultipleSelection to true, this property
contains a list of the selected indices in the reverse order in which they were selected.
That means the first element in the Vector corresponds to the last item selected.
The default value is null.
This property can be used as the source for data binding. When this property is modified, it dispatches the valueCommit event.
Implementation
public function get selectedIndices():Vector.<int> public function set selectedIndices(value:Vector.<int>):voidselectedItems | property |
selectedItems:Vector.<Object>| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
A Vector of Objects representing the currently selected data items.
If multiple selection is disabled by setting allowMultipleSelection
to false, and this property is set, the data item
corresponding to the first item in the Vector is selected.
If multiple selection is enabled by setting
allowMultipleSelection to true, this property
contains a list of the selected items in the reverse order in which they were selected.
That means the first element in the Vector corresponds to the last item selected.
The default value is null.
This property can be used as the source for data binding. When this property is modified, it dispatches the valueCommit event.
Implementation
public function get selectedItems():Vector.<Object> public function set selectedItems(value:Vector.<Object>):voiduseVirtualLayout | property |
useVirtualLayout:Boolean[override] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Sets the value of the useVirtualLayout property
of the layout associated with this control.
If the layout is subsequently replaced and the value of this
property is true, then the new layout's
useVirtualLayout property is set to true.
The default value is true.
Implementation
override public function get useVirtualLayout():Boolean override public function set useVirtualLayout(value:Boolean):voidConstructor Detail
List | () | Constructor |
public function List()| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Constructor.
Method Detail
addDragData | () | method |
public function addDragData(dragSource:DragSource):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Adds the selected items to the DragSource object as part of a drag-and-drop operation. Override this method to add other data to the drag source.
Parameters
dragSource:DragSource — The DragSource object to which to add the data.
|
adjustSelection | () | method |
override protected function adjustSelection(index:int, add:Boolean = false):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Adjusts the selected indices to account for items being added to or removed from this component.
Parameters
index:int — The new index.
| |
add:Boolean (default = false)true if an item was added to the component,
and false if an item was removed.
|
adjustSelectionAndCaretUponNavigation | () | method |
protected function adjustSelectionAndCaretUponNavigation(event:KeyboardEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Adjusts the selection based on what keystroke or keystroke combinations were encountered. The keystroke is sent down to the layout and it is up to the layout's getNavigationDestinationIndex() method to determine what the index to navigate to based on the item that is currently in focus. Once the index is determined, single selection, caret item and if necessary, multiple selections are updated to reflect the newly selected item.
Parameters
event:KeyboardEvent — The Keyboard Event encountered
|
calculateSelectedIndices | () | method |
protected function calculateSelectedIndices(index:int, shiftKey:Boolean, ctrlKey:Boolean):Vector.<int>| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Helper method to calculate how the current selection changes when an item is clicked.
Parameters
index:int — The index of the item that has been clicked.
| |
shiftKey:Boolean — True when the shift key is pressed.
| |
ctrlKey:Boolean — True when the control key is pressed.
|
Vector.<int> — The updated item indices that the new selection will be committed to.
|
See also
copyItemWithUID | () | method |
protected function copyItemWithUID(item:Object):Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Makes a deep copy of the object by calling the
ObjectUtil.copy() method, and replaces
the copy's uid property (if present) with a
new value by calling the UIDUtil.createUID() method.
This method is used for a drag and drop copy.
Parameters
item:Object — The item to copy.
|
Object — The copy of the object.
|
See also
createDragIndicator | () | method |
public function createDragIndicator():IFlexDisplayObject| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Creates an instance of a class that is used to display the visuals
of the dragged items during a drag and drop operation.
The default DragEvent.DRAG_START handler passes the
instance to the DragManager.doDrag() method.
IFlexDisplayObject |
createDropIndicator | () | method |
public function createDropIndicator():DisplayObject| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Creates and instance of the dropIndicator class that is used to
display the visuals of the drop location during a drag and drop
operation. The instance is set in the layout's
dropIndicator property.
If you override the dragEnter event handler,
and call preventDefault() so that the default handler does not execute,
call createDropIndicator() to create the drop indicator.
DisplayObject — Returns the dropIndicator that was set in the layout.
|
See also
destroyDropIndicator | () | method |
public function destroyDropIndicator():DisplayObject| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Releases the dropIndicator instance that is currently set in the layout.
If you override the dragExit event handler,
and call preventDefault() so that the default handler does not execute,
call destroyDropIndicator() to delete the drop indicator.
DisplayObject — Returns the dropIndicator that was removed.
|
See also
ensureIndexIsVisible | () | method |
public function ensureIndexIsVisible(index:int):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
A convenience method that handles scrolling a data item into view. If the data item at the specified index is not completely visible, the List scrolls until it is brought into view. If the data item is already in view, no additional scrolling occurs.
Parameters
index:int — The index of the data item.
|
Examples ( How to use this example )
ListExample.mxml
<?xml version="1.0"?>
<!-- Simple example to demonstrate the Spark List component -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" xmlns:s="library://ns.adobe.com/flex/spark">
<fx:Script>
<![CDATA[
import spark.events.IndexChangeEvent;
//this function is called when the selection is going to change
private function selectionChangingHandler(evt:IndexChangeEvent):void {
var item:* = list.dataProvider.getItemAt(evt.newIndex);
if (item.type != "employee") {
evt.preventDefault();
}
}
]]>
</fx:Script>
<s:Panel title="Spark List Component Example"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0">
<s:VGroup left="20" right="20" top="20" bottom="20">
<s:Label width="330"
text="Select a name to see employee's phone number. You should not be able to select the first name."/>
<s:List id="list" changing="selectionChangingHandler(event);">
<!-- itemRenderer is inline in this sample -->
<s:itemRenderer>
<fx:Component>
<s:ItemRenderer>
<s:states>
<s:State name="normal" />
<s:State name="hovered" />
<s:State name="selected" />
</s:states>
<s:Rect left="0" right="0" top="0" bottom="0">
<s:fill>
<s:SolidColor color="0x999999" alpha="0" alpha.hovered="0.2"
alpha.selected="0.6" />
</s:fill>
</s:Rect>
<s:Label id="nameLabel" text="{data.lastName}, {data.firstName}" top="5" left="5" right="5" />
<s:Label y="20" id="phoneLabel" text="{data.phone}" includeIn="selected" top="25" bottom="5" left="5" right="5" />
</s:ItemRenderer>
</fx:Component>
</s:itemRenderer>
<s:dataProvider>
<s:ArrayList>
<fx:Object type="hr" firstName="Ann" lastName="Green" />
<fx:Object type="employee" firstName="Tom" lastName="Smith" phone="415-155-1212" />
<fx:Object type="employee" firstName="John" lastName="Black" phone="408-344-1234" />
<fx:Object type="employee" firstName="Jane" lastName="White" phone="415-235-7878" />
<fx:Object type="employee" firstName="Bill" lastName="Jones" phone="415-875-7800" />
</s:ArrayList>
</s:dataProvider>
</s:List>
</s:VGroup>
</s:Panel>
</s:Application>
Fri Mar 19 2010, 02:45 AM -07:00