View comments | RSS feed
Packagefl.controls
Classpublic class TileList
InheritanceTileList Inheritance SelectableList Inheritance BaseScrollPane Inheritance UIComponent Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
Implements IFocusManagerComponent

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

The TileList class provides a grid of rows and columns that is typically used to format and display images in a "tiled" format. The default cell renderer for this component is the ImageCell class. An ImageCell cell renderer displays a thumbnail image and a single-line label. To render a list-based cell in a TileList component, use the CellRenderer class.

To modify the padding that separates the cell border from the image, you can globally set the imagePadding style, or set it on the ImageCell class. Like other cell styles, the imagePadding style cannot be set on the TileList component instance.

View the examples

See also

fl.controls.listClasses.CellRenderer
fl.controls.listClasses.ImageCell


Public Properties
 PropertyDefined By
 InheritedaccessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
DisplayObject
 InheritedallowMultipleSelection : Boolean
Gets a Boolean value that indicates whether more than one list item can be selected at a time.
SelectableList
 Inheritedalpha : Number
Indicates the alpha transparency value of the object specified.
DisplayObject
 InheritedblendMode : String
A value from the BlendMode class that specifies which blend mode to use.
DisplayObject
 InheritedbuttonMode : Boolean
Specifies the button mode of this sprite.
Sprite
 InheritedcacheAsBitmap : Boolean
If set to true, Flash Player or Adobe AIR caches an internal bitmap representation of the display object.
DisplayObject
  columnCount : uint
Gets or sets the number of columns that are at least partially visible in the list.
TileList
  columnWidth : Number
Gets or sets the width that is applied to a column in the list, in pixels.
TileList
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcontextMenu : 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.
TileList
  direction : String
Gets or sets a value that indicates whether the TileList component scrolls horizontally or vertically.
TileList
 InheriteddoubleClickEnabled : Boolean
Specifies whether the object receives doubleClick events.
InteractiveObject
 InheriteddropTarget : DisplayObject
[read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped.
Sprite
 Inheritedenabled : Boolean
Gets or sets a value that indicates whether the component can accept user interaction.
UIComponent
 Inheritedfilters : Array
An indexed array that contains each filter object currently associated with the display object.
DisplayObject
 InheritedfocusEnabled : Boolean
Gets or sets a Boolean value that indicates whether the component can receive focus after the user clicks it.
UIComponent
 InheritedfocusManager : IFocusManager
Gets or sets the FocusManager that controls focus for this component and its peers.
UIComponent
 InheritedfocusRect : Object
Specifies whether this object displays a focus rectangle.
InteractiveObject
 Inheritedgraphics : Graphics
[read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur.
Sprite
 Inheritedheight : Number
Gets or sets the height of the component, in pixels.
UIComponent
 InheritedhitArea : Sprite
Designates another sprite to serve as the hit area for a sprite.
Sprite
 InheritedhorizontalLineScrollSize : Number
Gets or sets a value that describes the amount of content to be scrolled, horizontally, when a scroll arrow is clicked.
BaseScrollPane
 InheritedhorizontalPageScrollSize : 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
 InheritedhorizontalScrollBar : ScrollBar
[read-only] Gets a reference to the horizontal scroll bar.
BaseScrollPane
 InheritedhorizontalScrollPolicy : String
Gets or sets a value that indicates the state of the horizontal scroll bar.
BaseScrollPane
 InheritedhorizontalScrollPosition : 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.
TileList
  iconFunction : Function
Gets or sets the function to be used to obtain the icon for the item.
TileList
  innerHeight : Number
[read-only] Gets the height of the content area, in pixels.
TileList
  innerWidth : Number
[read-only] Gets the width of the content area, in pixels.
TileList
  labelField : String
Gets or sets a field in each item that contains a label for each tile.
TileList
  labelFunction : Function
Gets a function that indicates the fields of an item that provide the label text for a tile.
TileList
 Inheritedlength : uint
[read-only] Gets the number of items in the data provider.
SelectableList
 InheritedloaderInfo : LoaderInfo
[read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.
DisplayObject
 Inheritedmask : DisplayObject
The calling display object is masked by the specified mask object.
DisplayObject
  maxHorizontalScrollPosition : Number
Gets the maximum horizontal scroll position for the current content, in pixels.
TileList
 InheritedmaxVerticalScrollPosition : Number
[read-only] Gets the maximum vertical scroll position for the current content, in pixels.
BaseScrollPane
 InheritedmouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled.
DisplayObjectContainer
 InheritedmouseEnabled : Boolean
Specifies whether this object receives mouse messages.
InteractiveObject
 InheritedmouseFocusEnabled : Boolean
Gets or sets a value that indicates whether the component can receive focus after the user clicks it.
UIComponent
 InheritedmouseX : Number
[read-only] Indicates the x coordinate of the mouse position, in pixels.
DisplayObject
 InheritedmouseY : Number
[read-only] Indicates the y coordinate of the mouse position, in pixels.
DisplayObject
 Inheritedname : String
Indicates the instance name of the DisplayObject.
DisplayObject
 InheritednumChildren : int
[read-only] Returns the number of children of this object.
DisplayObjectContainer
 InheritedopaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
DisplayObject
 Inheritedparent : DisplayObjectContainer
[read-only] Indicates the DisplayObjectContainer object that contains this display object.
DisplayObject
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 Inheritedroot : 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
 Inheritedrotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
DisplayObject
  rowCount : uint
Gets or sets the number of rows that are at least partially visible in the list.
TileList
  rowHeight : Number
Gets or sets the height that is applied to each row in the list, in pixels.
TileList
 Inheritedscale9Grid : Rectangle
The current scaling grid that is in effect.
DisplayObject
 InheritedscaleX : Number
Multiplies the current width of the component by a scale factor.
UIComponent
 InheritedscaleY : Number
Multiplies the current height of the component by a scale factor.
UIComponent
  scrollPolicy : String
Gets or sets the scroll policy for the TileList component.
TileList
 InheritedscrollRect : Rectangle
The scroll rectangle bounds of the display object.
DisplayObject
 Inheritedselectable : Boolean
Gets or sets a Boolean value that indicates whether the items in the list can be selected.
SelectableList
 InheritedselectedIndex : int
Gets or sets the index of the item that is selected in a single-selection list.
SelectableList
 InheritedselectedIndices : Array
Gets or sets an array that contains the items that were selected from a multiple-selection list.
SelectableList
 InheritedselectedItem : Object
Gets or sets the item that was selected from a single-selection list.
SelectableList
 InheritedselectedItems : Array
Gets or sets an array that contains the objects for the items that were selected from the multiple-selection list.
SelectableList
 InheritedsoundTransform : SoundTransform
Controls sound within this sprite.
Sprite
  sourceField : String
Gets or sets the item field that provides the source path for a tile.
TileList
  sourceFunction : Function
Gets or sets the function to be used to obtain the source path for a tile.
TileList
 Inheritedstage : Stage
[read-only] The Stage of the display object.
DisplayObject
 InheritedtabChildren : Boolean
Determines whether the children of the object are tab enabled.
DisplayObjectContainer
 InheritedtabEnabled : Boolean
Specifies whether this object is in the tab order.
InteractiveObject
 InheritedtabIndex : int
Specifies the tab ordering of objects in a SWF file.
InteractiveObject
 InheritedtextSnapshot : TextSnapshot
[read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.
DisplayObjectContainer
 Inheritedtransform : Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
DisplayObject
 InheriteduseBitmapScrolling : 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
 InheriteduseHandCursor : 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
 Inheritedversion : String = "3.0.0.15"
The version number of the components.
UIComponent
 InheritedverticalLineScrollSize : Number
Gets or sets a value that describes how many pixels to scroll vertically when a scroll arrow is clicked.
BaseScrollPane
 InheritedverticalPageScrollSize : 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
 InheritedverticalScrollBar : ScrollBar
[read-only] Gets a reference to the vertical scroll bar.
BaseScrollPane
 InheritedverticalScrollPolicy : String
Gets or sets a value that indicates the state of the vertical scroll bar.
BaseScrollPane
 InheritedverticalScrollPosition : Number
Gets or sets a value that describes the vertical position of the vertical scroll bar in the scroll pane, in pixels.
BaseScrollPane
 Inheritedvisible : Boolean
Gets or sets a value that indicates whether the current component instance is visible.
UIComponent
 Inheritedwidth : Number
Gets or sets the width of the component, in pixels.
UIComponent
 Inheritedx : Number
Gets or sets the x coordinate that represents the position of the component along the x axis within its parent container.
UIComponent
 Inheritedy : Number
Gets or sets the y coordinate that represents the position of the component along the y axis within its parent container.
UIComponent
Public Methods
 MethodDefined By
  
Creates a new List component instance.
TileList
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
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
 Inherited
Appends an item to the end of the list of items.
SelectableList
 Inherited
addItemAt(item:Object, index:uint):void
Inserts an item into the list at the specified index location.
SelectableList
 Inherited
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
 Inherited
clearRendererStyle(name:String, column:int = -1):void
Clears a style that is set on the renderers in the list.
SelectableList
 Inherited
Clears the currently selected item in the list and sets the selectedIndex property to -1.
SelectableList
 Inherited
Deletes a style property from this component instance.
UIComponent
 Inherited
Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.
DisplayObjectContainer
 Inherited
Dispatches an event into the event flow.
EventDispatcher
 Inherited
Shows or hides the focus indicator on this component.
UIComponent
 Inherited
Initiates an immediate draw operation, without invalidating everything as invalidateNow does.
UIComponent
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.
DisplayObject
 Inherited
Returns the child display object instance that exists at the specified index.
DisplayObjectContainer
 Inherited
Returns the child display object that exists with the specified name.
DisplayObjectContainer
 Inherited
Returns the index position of a child DisplayObject instance.
DisplayObjectContainer
 Inherited
Retrieves the object that currently has focus.
UIComponent
 Inherited
Retrieves the item at the specified index.
SelectableList
 Inherited
getNextIndexAtLetter(firstLetter:String, startIndex:int = -1):int
Returns the index of the next item in the dataProvider in which the label's first character matches a specified string character.
SelectableList
 Inherited
Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
getRect(targetCoordinateSpace:DisplayObject):Rectangle
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
 Inherited
getRendererStyle(name:String, column:int = -1):Object
Retrieves a style that is set on the renderers in the list.
SelectableList
 Inherited
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.
TileList
 Inherited
Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.
DisplayObject
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Evaluates the display object to see if it overlaps or intersects with the obj display object.
DisplayObject
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters.
DisplayObject
 Inherited
invalidate(property:String, callLater:Boolean = true):void
Marks a property as invalid and redraws the component on the next frame unless otherwise specified.
UIComponent
 Inherited
Invalidates a specific item renderer.
SelectableList
 Inherited
Invalidates the renderer for the item at the specified index.
SelectableList
 Inherited
Invalidates the whole list, forcing the list items to be redrawn.
SelectableList
 Inherited
Checks whether the specified item is selected in the list.
SelectableList
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Retrieves the ICellRenderer for a given item object, if there is one.
SelectableList
  
Retrieves the string that the renderer displays for a given data object based on the labelField and labelFunction properties.
TileList
 Inherited
Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.
DisplayObject
 Inherited
[static] Merges the styles from multiple classes into one object.
UIComponent
 Inherited
Moves the component to the specified position within its parent.
UIComponent
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Removes all items from the list.
SelectableList
 Inherited
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.
DisplayObjectContainer
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Removes the specified item from the list.
SelectableList
 Inherited
Removes the item at the specified index position.
SelectableList
 Inherited
Replaces the item at the specified index location with another item.
SelectableList
  
scrollToIndex(newCaretIndex:int):void
Scrolls the list to the item at the specified index.
TileList
 Inherited
Scrolls the list to the item at the location indicated by the current value of the selectedIndex property.
SelectableList
 Inherited
Changes the position of an existing child in the display object container.
DisplayObjectContainer
 Inherited
Sets the focus to this component.
UIComponent
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
setRendererStyle(name:String, style:Object, column:uint = 0):void
Sets a style on the renderers in the list.
SelectableList
 Inherited
setSize(width:Number, height:Number):void
Sets the component to the specified width and height.
UIComponent
 Inherited
setStyle(style:String, value:Object):void
Sets a style property on this component instance.
UIComponent
 Inherited
sortItems(... sortArgs):*
Sorts the elements of the current data provider.
SelectableList
 Inherited
sortItemsOn(field:String, options:Object = null):*
Sorts the elements of the current data provider by one or more of its fields.
SelectableList
 Inherited
startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite.
Sprite
 Inherited
Ends the startDrag() method.
Sprite
 Inherited
Swaps the z-order (front-to-back order) of the two specified child objects.
DisplayObjectContainer
 Inherited
swapChildrenAt(index1:int, index2:int):void
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list.
DisplayObjectContainer
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Validates and updates the properties and layout of this object, redrawing it if necessary.
UIComponent
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Events
 Event Summary Defined By
 Inherited Dispatched when Flash Player or an AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited Dispatched when a display object is added to the display list.DisplayObject
 Inherited Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
 Inherited Dispatched when a different item is selected in the list.SelectableList
 Inherited Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.InteractiveObject
 Inherited Dispatched when the user selects the context menu associated with this interactive object in an AIR application.InteractiveObject
 Inherited Dispatched when Flash Player or an AIR application loses operating system focus and is becoming inactive.EventDispatcher
 Inherited Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true.InteractiveObject
 Inherited Dispatched when the playhead is entering a new frame.DisplayObject
 Inherited Dispatched after a display object gains focus.InteractiveObject
 Inherited Dispatched after a display object loses focus.InteractiveObject
 Inherited Dispatched after the component visibility changes from visible to invisible.UIComponent
 Inherited Dispatched when the user clicks an item in the component.SelectableList
 Inherited Dispatched when the user clicks an item in the component twice in rapid succession.SelectableList
 Inherited Dispatched when the user rolls the pointer off of an item in the component.SelectableList
 Inherited Dispatched when the user rolls the pointer over an item in the component.SelectableList
 Inherited Dispatched when the user presses a key.InteractiveObject
 Inherited Dispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 Inherited Dispatched when the user releases a key.InteractiveObject
 Inherited Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.InteractiveObject
 Inherited Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited