| Package | mx.controls |
| Class | public class TileList |
| Inheritance | TileList  TileBase ListBase ScrollControlBase UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
 | Starting with Flex 4.0, Adobe recommends that you use the spark.components.List class as an alternative to this class.
The layout-specific List components in Flex 3 have been replaced by a more generic
List component that takes a generic layout. To get similar behavior from the new
List component, set the |
The TileList control displays a number of items laid out in tiles. It displays a scroll bar on one of its axes to access all items in the list, depending on the
direction property.
You can set the size of the tiles by using rowHeight
and columnWidth properties.
Alternatively, Flex measures the item renderer for the first item
in the dataProvider and uses that size for all tiles.
The TileList control has the following default sizing characteristics:
| Characteristic | Description |
|---|---|
| Default size | Four columns and four rows. Using the default item renderer, the total size is 66 by 126 pixels. |
| Minimum size | 0 pixels. |
| Maximum size | 5000 by 5000. |
Show MXML Syntax
Hide MXML SyntaxThe <mx:TileList> tag inherits
all of the tag attributes of its superclass, but ignores the
variableRowHeight and wordWrap tag attributes.
It adds no additional tag attributes.
<mx:TileList/>
Default MXML PropertydataProvider
More examples
Creating a TileList control
Creating an MX item renderer and item editor
Creating MX drop-in item renderers and item editors
Creating MX inline item renderers and editors
Creating MX item renderers and item editor components
Creating an MX item renderer in ActionScript
Working with MX item renderers
Example: Using an item renderer with the MX TileList and HorizontalList controls
Creating an MX item renderer and item editor
Creating MX drop-in item renderers and item editors
Creating MX inline item renderers and editors
Creating MX item renderers and item editor components
Creating an MX item renderer in ActionScript
Working with MX item renderers
Example: Using an item renderer with the MX TileList and HorizontalList controls
Learn more
MX TileList control
TileList control user interaction
About MX item renderers
About the MX item renderer and item editor life cycle
Using drag-and-drop with list-based controls
Dragging and dropping between different list-based controls
Manually adding drag-and-drop support
Example: Handling drag and drop events in a list-based control
Drag and drop examples
TileList control user interaction
About MX item renderers
About the MX item renderer and item editor life cycle
Using drag-and-drop with list-based controls
Dragging and dropping between different list-based controls
Manually adding drag-and-drop support
Example: Handling drag and drop events in a list-based control
Drag and drop examples
Public Properties
Protected Properties
Public Methods
| Method | Defined By | ||
|---|---|---|---|
TileList()
Constructor. | TileList | ||
 |
Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Adds a child DisplayObject instance to this DisplayObjectContainer
instance. | DisplayObjectContainer | |
|
Adds an item renderer if a data change effect is running. | ListBase | |
| 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 | |
|
Adds a non-visual style client to this component instance. | UIComponent | |
|
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 | |
|
Returns the index where the dropped items should be added
to the drop target. | ListBase | |
|
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 | |
| [override]
Get the appropriate renderer, using the default renderer if none is specified. | TileBase | |
|
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 | |
|
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 | |
|
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | |
|
Finds an item in the list based on a String,
and moves the selection to it. | ListBase | |
|
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 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 | |
|
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 | |
|
Return the appropriate factory, using the default factory if none specified. | ListBase | |
|
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 true or false
to indicates whether the effect should play on the target. | ListBase | |
|
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 | |
|
Returns true if currentCSSState is not null. | UIComponent | |
|
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 | |
|
Hides the drop indicator under the mouse pointer that indicates that a
drag and drop operation is allowed. | ListBase | |
|
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 | |
|
Get an item renderer for the index of an item in the data provider,
if one exists. | ListBase | |
|
Computes the offset into the data provider of the item
at colIndex, rowIndex. | ListBase | |
|
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 | |
|
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | |
|
Refresh all rows on the next update. | ListBase | |
|
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 | |
|
Determines if the item renderer for a data provider item
is highlighted (is rolled over via the mouse or under the caret due to keyboard navigation). | ListBase | |
|
Determines if the item renderer for a data provider item
is selectable. | ListBase | |
|
Determines if the item renderer for a data provider item
is selected. | ListBase | |
|
Determines if the item renderer for a data provider item
is the item under the caret due to keyboard navigation. | ListBase | |
|
Determines if an item is being displayed by a renderer. | ListBase | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Determines whether a renderer contains (or owns) a display object. | ListBase | |
|
Returns the index of the item in the data provider of the item
being rendered by this item renderer. | ListBase | |
|
Returns the dataTip string the renderer would display for the given
data object based on the dataTipField and dataTipFunction properties. | ListBase | |
|
Returns the class for an icon, if any, for a data item,
based on the iconField and iconFunction properties. | ListBase | |
|
Returns the item renderer for a given item in the data provider,
if there is one. | ListBase | |
|
Returns the string the renderer would display for the given data object
based on the labelField and labelFunction properties. | 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 a set of items from the data provider using the
current item renderer and returns the sum of the heights
of those items. | ListBase | |
|
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 | |
|
Measures a set of items from the data provider using
the current item renderer and returns the
maximum width found. | ListBase | |
|
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 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 all child DisplayObject instances from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes an item renderer if a data change effect is running. | ListBase | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Removes a non-visual style client from this component instance. | UIComponent | |
|
Replays the specified event. | UIComponent | |
|
Raises a virtual keyboard. | InteractiveObject | |
|
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 | |
|
Ensures that the data provider item at the given index is visible. | ListBase | |
|
Sizes the object. | UIComponent | |
|
Changes the position of an existing child in the display object container. | DisplayObjectContainer | |
|
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 | |
|
Displays a drop indicator under the mouse pointer to indicate that a
drag and drop operation is allowed and where the items will
be dropped. | ListBase | |
|
Lets the user drag the specified sprite. | Sprite | |
|
Lets the user drag the specified sprite on a touch-enabled device. | Sprite | |
|
Recursively stops the timeline execution of all MovieClips rooted at this object. | DisplayObjectContainer | |
|
Ends the startDrag() method. | Sprite | |
|
Ends the startTouchDrag() method, for use with touch-enabled devices. | 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 | |
|
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 | |
| [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 | |
|
Called by an UnconstrainItemAction effect
as part of a data change effect if the item renderers corresponding
to certain data items need to move outside the normal positions
of item renderers in the control. | ListBase | |
|
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
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
Spark Theme Styles
Halo Theme Styles
Effects
| Effect | Description | Defined By | ||
|---|---|---|---|---|
| Triggering Event: added Played when the component is added as a child to a Container. | UIComponent | ||
| Triggering Event: creationComplete Played when the component is created. | UIComponent | ||
| Triggering Event: focusIn Played when the component gains keyboard focus. | UIComponent | ||
| Triggering Event: focusOut Played when the component loses keyboard focus. | UIComponent | ||
| Triggering Event: hide Played when the component becomes invisible. | UIComponent | ||
itemsChangeEffect | Triggering Event: itemsChange The data effect to play when a change occur to the control's data provider. By default, the TileList control does not use a data effect. For the TileList control, use an instance of the DefaultTileListEffect class. | TileList | ||
| Triggering Event: mouseDown Played when the user presses the mouse button while over the component. | UIComponent | ||
| Triggering Event: mouseUp Played when the user releases the mouse button while over the component. | UIComponent | ||
| Triggering Event: move Played when the component is moved. | UIComponent | ||
| Triggering Event: removed Played when the component is removed from a Container. | UIComponent | ||
| Triggering Event: resize Played when the component is resized. | UIComponent | ||
| Triggering Event: rollOut Played when the user rolls the mouse so it is no longer over the component. | UIComponent | ||
| Triggering Event: rollOver Played when the user rolls the mouse over the component. | UIComponent | ||
| Triggering Event: show Played when the component becomes visible. | UIComponent | ||
Public Constants
Constructor Detail
TileList | () | Constructor |
public function TileList()| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
Examples How to use this example
TileListExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the Halo TileList Control. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
xmlns:s="library://ns.adobe.com/flex/spark"
xmlns:mx="library://ns.adobe.com/flex/mx">
<fx:Script>
<![CDATA[
[Embed(source="assets/Nokia_6630.png")]
public const phone1:Class;
[Embed(source="assets/Nokia_6680.png")]
public const phone2:Class;
[Embed(source="assets/Nokia_7610.png")]
public const phone3:Class;
[Embed(source="assets/Nokia_lg_v_keypad.png")]
public const phone4:Class;
[Embed(source="assets/Nokia_sm_v_keypad.png")]
public const phone5:Class;
]]>
</fx:Script>
<s:Panel title="Halo TileList Control Example"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0">
<s:VGroup left="10" right="10" top="10" bottom="10">
<s:Label width="100%" color="blue"
text="A TileList control displays items in rows and columns."/>
<mx:TileList id="CameraSelection" height="250" width="300"
maxColumns="2" rowHeight="225" columnWidth="125">
<mx:dataProvider>
<fx:Array>
<fx:Object label="Nokia 6630" icon="{phone1}"/>
<fx:Object label="Nokia 6680" icon="{phone2}"/>
<fx:Object label="Nokia 7610" icon="{phone3}"/>
<fx:Object label="Nokia LGV" icon="{phone4}"/>
<fx:Object label="Nokia LMV" icon="{phone5}"/>
</fx:Array>
</mx:dataProvider>
</mx:TileList>
</s:VGroup>
</s:Panel>
</s:Application>
Thu Dec 6 2018, 01:12 PM -08:00