fl.controls.TileList - ActionScript® 3.0 Reference for the Adobe® Flash® Platform

Package	fl.controls
Class	public class TileList
Inheritance	TileList SelectableList BaseScrollPane UIComponent Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object
Implements	IFocusManagerComponent

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

The 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

Related API Elements

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

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		accessibilityImplementation : AccessibilityImplementation The current accessibility implementation (AccessibilityImplementation) for this InteractiveObject instance.	InteractiveObject
		accessibilityProperties : AccessibilityProperties The current accessibility options for this display object.	DisplayObject
		allowMultipleSelection : Boolean Gets a Boolean value that indicates whether more than one list item can be selected at a time.	SelectableList
		alpha : Number Indicates the alpha transparency value of the object specified.	DisplayObject
		blendMode : String A value from the BlendMode class that specifies which blend mode to use.	DisplayObject
		blendShader : Shader [write-only] Sets a shader that is used for blending the foreground and background.	DisplayObject
		buttonMode : Boolean Specifies the button mode of this sprite.	Sprite
		cacheAsBitmap : Boolean If set to true, Flash runtimes cache an internal bitmap representation of the display object.	DisplayObject
		cacheAsBitmapMatrix : Matrix If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true.	DisplayObject
		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
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		contextMenu : NativeMenu Specifies the context menu associated with this object.	InteractiveObject
		dataProvider : DataProvider [override] 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
		doubleClickEnabled : Boolean Specifies whether the object receives doubleClick events.	InteractiveObject
		dropTarget : DisplayObject [read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped.	Sprite
		enabled : Boolean Gets or sets a value that indicates whether the component can accept user interaction.	UIComponent
		filters : Array An indexed array that contains each filter object currently associated with the display object.	DisplayObject
		focusEnabled : Boolean Gets or sets a Boolean value that indicates whether the component can receive focus after the user clicks it.	UIComponent
		focusManager : IFocusManager Gets or sets the FocusManager that controls focus for this component and its peers.	UIComponent
		focusRect : Object Specifies whether this object displays a focus rectangle.	InteractiveObject
		graphics : Graphics [read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur.	Sprite
		height : Number [override] Gets or sets the height of the component, in pixels.	UIComponent
		hitArea : Sprite Designates another sprite to serve as the hit area for a sprite.	Sprite
		horizontalLineScrollSize : Number Gets or sets a value that describes the amount of content to be scrolled, horizontally, when a scroll arrow is clicked.	BaseScrollPane
		horizontalPageScrollSize : Number Gets or sets the count of pixels by which to move the scroll thumb on the horizontal scroll bar when the scroll bar track is pressed.	BaseScrollPane
		horizontalScrollBar : ScrollBar [read-only] Gets a reference to the horizontal scroll bar.	BaseScrollPane
		horizontalScrollPolicy : String Gets or sets a value that indicates the state of the horizontal scroll bar.	BaseScrollPane
		horizontalScrollPosition : Number Gets or sets a value that describes the horizontal position of the horizontal scroll bar in the scroll pane, in pixels.	BaseScrollPane
		iconField : String Gets or sets the item field that provides the icon for the item.	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
		length : uint [read-only] Gets the number of items in the data provider.	SelectableList
		loaderInfo : LoaderInfo [read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.	DisplayObject
		mask : DisplayObject The calling display object is masked by the specified mask object.	DisplayObject
		maxHorizontalScrollPosition : Number [override] Gets the maximum horizontal scroll position for the current content, in pixels.	TileList
		maxVerticalScrollPosition : Number [read-only] Gets the maximum vertical scroll position for the current content, in pixels.	BaseScrollPane
		mouseChildren : Boolean Determines whether or not the children of the object are mouse, or user input device, enabled.	DisplayObjectContainer
		mouseEnabled : Boolean Specifies whether this object receives mouse, or other user input, messages.	InteractiveObject
		mouseFocusEnabled : Boolean Gets or sets a value that indicates whether the component can receive focus after the user clicks it.	UIComponent
		mouseX : Number [read-only] Indicates the x coordinate of the mouse or user input device position, in pixels.	DisplayObject
		mouseY : Number [read-only] Indicates the y coordinate of the mouse or user input device position, in pixels.	DisplayObject
		name : String Indicates the instance name of the DisplayObject.	DisplayObject
		needsSoftKeyboard : Boolean Specifies whether a virtual keyboard (an on-screen, software keyboard) should display when this InteractiveObject instance receives focus.	InteractiveObject
		numChildren : int [read-only] Returns the number of children of this object.	DisplayObjectContainer
		opaqueBackground : Object Specifies whether the display object is opaque with a certain background color.	DisplayObject
		parent : DisplayObjectContainer [read-only] Indicates the DisplayObjectContainer object that contains this display object.	DisplayObject
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		root : DisplayObject [read-only] For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file.	DisplayObject
		rotation : Number Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.	DisplayObject
		rotationX : Number Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		rotationY : Number Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		rotationZ : Number Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		rowCount : uint [override] Gets or sets the number of rows that are at least partially visible in the list.	TileList
		rowHeight : Number Gets or sets the height that is applied to each row in the list, in pixels.	TileList
		scale9Grid : Rectangle The current scaling grid that is in effect.	DisplayObject
		scaleX : Number [override] Multiplies the current width of the component by a scale factor.	UIComponent
		scaleY : Number [override] Multiplies the current height of the component by a scale factor.	UIComponent
		scaleZ : Number Indicates the depth scale (percentage) of an object as applied from the registration point of the object.	DisplayObject
		scrollPolicy : String Gets or sets the scroll policy for the TileList component.	TileList
		scrollRect : Rectangle The scroll rectangle bounds of the display object.	DisplayObject
		selectable : Boolean Gets or sets a Boolean value that indicates whether the items in the list can be selected.	SelectableList
		selectedIndex : int Gets or sets the index of the item that is selected in a single-selection list.	SelectableList
		selectedIndices : Array Gets or sets an array that contains the items that were selected from a multiple-selection list.	SelectableList
		selectedItem : Object Gets or sets the item that was selected from a single-selection list.	SelectableList
		selectedItems : Array Gets or sets an array that contains the objects for the items that were selected from the multiple-selection list.	SelectableList
		softKeyboardInputAreaOfInterest : Rectangle Defines the area that should remain on-screen when a soft keyboard is displayed.	InteractiveObject
		soundTransform : flash.media:SoundTransform Controls sound within this sprite.	Sprite
		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
		stage : Stage [read-only] The Stage of the display object.	DisplayObject
		tabChildren : Boolean Determines whether the children of the object are tab enabled.	DisplayObjectContainer
		tabEnabled : Boolean Specifies whether this object is in the tab order.	InteractiveObject
		tabIndex : int Specifies the tab ordering of objects in a SWF file.	InteractiveObject
		textSnapshot : flash.text:TextSnapshot [read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.	DisplayObjectContainer
		transform : flash.geom:Transform An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.	DisplayObject
		useBitmapScrolling : Boolean When set to true, the cacheAsBitmap property for the scrolling content is set to true; when set to false this value is turned off.	BaseScrollPane
		useHandCursor : Boolean A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls over a sprite in which the buttonMode property is set to true.	Sprite
		verticalLineScrollSize : Number Gets or sets a value that describes how many pixels to scroll vertically when a scroll arrow is clicked.	BaseScrollPane
		verticalPageScrollSize : Number Gets or sets the count of pixels by which to move the scroll thumb on the vertical scroll bar when the scroll bar track is pressed.	BaseScrollPane
		verticalScrollBar : ScrollBar [read-only] Gets a reference to the vertical scroll bar.	BaseScrollPane
		verticalScrollPolicy : String Gets or sets a value that indicates the state of the vertical scroll bar.	BaseScrollPane
		verticalScrollPosition : Number Gets or sets a value that describes the vertical position of the vertical scroll bar in the scroll pane, in pixels.	BaseScrollPane
		visible : Boolean [override] Gets or sets a value that indicates whether the current component instance is visible.	UIComponent
		width : Number [override] Gets or sets the width of the component, in pixels.	UIComponent
		x : Number [override] Gets or sets the x coordinate that represents the position of the component along the x axis within its parent container.	UIComponent
		y : Number [override] Gets or sets the y coordinate that represents the position of the component along the y axis within its parent container.	UIComponent
		z : Number Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.	DisplayObject

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		TileList() Creates a new List component instance.	TileList
		addChild(child:DisplayObject):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance.	DisplayObjectContainer
		addChildAt(child:DisplayObject, index:int):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance.	DisplayObjectContainer
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		addItem(item:Object):void Appends an item to the end of the list of items.	SelectableList
		addItemAt(item:Object, index:uint):void Inserts an item into the list at the specified index location.	SelectableList
		areInaccessibleObjectsUnderPoint(point:Point):Boolean 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
		clearRendererStyle(name:String, column:int = -1):void Clears a style that is set on the renderers in the list.	SelectableList
		clearSelection():void Clears the currently selected item in the list and sets the selectedIndex property to -1.	SelectableList
		clearStyle(style:String):void Deletes a style property from this component instance.	UIComponent
		contains(child:DisplayObject):Boolean Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.	DisplayObjectContainer
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		drawFocus(focused:Boolean):void Shows or hides the focus indicator on this component.	UIComponent
		drawNow():void Initiates an immediate draw operation, without invalidating everything as invalidateNow does.	UIComponent
		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
		getChildAt(index:int):DisplayObject Returns the child display object instance that exists at the specified index.	DisplayObjectContainer
		getChildByName(name:String):DisplayObject Returns the child display object that exists with the specified name.	DisplayObjectContainer
		getChildIndex(child:DisplayObject):int Returns the index position of a child DisplayObject instance.	DisplayObjectContainer
		getFocus():InteractiveObject Retrieves the object that currently has focus.	UIComponent
		getItemAt(index:uint):Object Retrieves the item at the specified index.	SelectableList
		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
		getObjectsUnderPoint(point:Point):Array Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.	DisplayObjectContainer
		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
		getRendererStyle(name:String, column:int = -1):Object Retrieves a style that is set on the renderers in the list.	SelectableList
		getStyle(style:String):Object Retrieves a style property that is set in the style lookup chain of the component.	UIComponent
		getStyleDefinition():Object [static] Retrieves the default style map for the current component.	TileList
		globalToLocal(point:Point):Point Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.	DisplayObject
		globalToLocal3D(point:Point):Vector3D Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.	DisplayObject
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		hitTestObject(obj:DisplayObject):Boolean 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
		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
		invalidate(property:String, callLater:Boolean = true):void Marks a property as invalid and redraws the component on the next frame unless otherwise specified.	UIComponent
		invalidateItem(item:Object):void Invalidates a specific item renderer.	SelectableList
		invalidateItemAt(index:uint):void Invalidates the renderer for the item at the specified index.	SelectableList
		invalidateList():void Invalidates the whole list, forcing the list items to be redrawn.	SelectableList
		isItemSelected(item:Object):Boolean Checks whether the specified item is selected in the list.	SelectableList
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		itemToCellRenderer(item:Object):ICellRenderer Retrieves the ICellRenderer for a given item object, if there is one.	SelectableList
		itemToLabel(item:Object):String [override] Retrieves the string that the renderer displays for a given data object based on the labelField and labelFunction properties.	TileList
		local3DToGlobal(point3d:Vector3D):Point 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
		localToGlobal(point:Point):Point Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.	DisplayObject
		mergeStyles(... list):Object [static] Merges the styles from multiple classes into one object.	UIComponent
		move(x:Number, y:Number):void Moves the component to the specified position within its parent.	UIComponent
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeAll():void Removes all items from the list.	SelectableList
		removeChild(child:DisplayObject):DisplayObject Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.	DisplayObjectContainer
		removeChildAt(index:int):DisplayObject Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.	DisplayObjectContainer
		removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):void Removes one or more child DisplayObject instances from the DisplayObjectContainer instance.	DisplayObjectContainer
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		removeItem(item:Object):Object Removes the specified item from the list.	SelectableList
		removeItemAt(index:uint):Object Removes the item at the specified index position.	SelectableList
		replaceItemAt(item:Object, index:uint):Object Replaces the item at the specified index location with another item.	SelectableList
		requestSoftKeyboard():Boolean Raises a virtual keyboard.	InteractiveObject
		scrollToIndex(newCaretIndex:int):void [override] Scrolls the list to the item at the specified index.	TileList
		scrollToSelected():void Scrolls the list to the item at the location indicated by the current value of the selectedIndex property.	SelectableList
		setChildIndex(child:DisplayObject, index:int):void Changes the position of an existing child in the display object container.	DisplayObjectContainer
		setFocus():void Sets the focus to this component.	UIComponent
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		setRendererStyle(name:String, style:Object, column:uint = 0):void Sets a style on the renderers in the list.	SelectableList
		setSize(width:Number, height:Number):void Sets the component to the specified width and height.	UIComponent
		setStyle(style:String, value:Object):void Sets a style property on this component instance.	UIComponent
		sortItems(... sortArgs):* Sorts the elements of the current data provider.	SelectableList
		sortItemsOn(field:String, options:Object = null):* Sorts the elements of the current data provider by one or more of its fields.	SelectableList
		startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite.	Sprite
		startTouchDrag(touchPointID:int, lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite on a touch-enabled device.	Sprite
		stopDrag():void Ends the startDrag() method.	Sprite
		stopTouchDrag(touchPointID:int):void Ends the startTouchDrag() method, for use with touch-enabled devices.	Sprite
		swapChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the z-order (front-to-back order) of the two specified child objects.	DisplayObjectContainer
		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
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		validateNow():void Validates and updates the properties and layout of this object, redrawing it if necessary.	UIComponent
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		getStyleValue(name:String):Object Returns the specified style for a component, considering all styles set on the global level, component level and instance level.	UIComponent

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
added	Dispatched when a display object is added to the display list.	DisplayObject
addedToStage	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
change	Dispatched when a different item is selected in the list.	SelectableList
clear	Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu.	InteractiveObject
click	Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.	InteractiveObject
contextMenu	Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application.	InteractiveObject
copy	Dispatched when the user activates the platform-specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu.	InteractiveObject
cut	Dispatched when the user activates the platform-specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu.	InteractiveObject
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
doubleClick	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
enterFrame	[broadcast event] Dispatched when the playhead is entering a new frame.	DisplayObject
exitFrame	[broadcast event] Dispatched when the playhead is exiting the current frame.	DisplayObject
focusIn	Dispatched after a display object gains focus.	InteractiveObject
focusOut	Dispatched after a display object loses focus.	InteractiveObject
frameConstructed	[broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.	DisplayObject
gesturePan	Dispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a finger from left to right over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
gesturePressAndTap	Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen).	InteractiveObject
gestureRotate	Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
gestureSwipe	Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
gestureTwoFingerTap	Dispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
gestureZoom	Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
hide	Dispatched after the component visibility changes from visible to invisible.	UIComponent
imeStartComposition	This event is dispatched to any client app that supports inline input with an IME	InteractiveObject
itemClick	Dispatched when the user clicks an item in the component.	SelectableList
itemDoubleClick	Dispatched when the user clicks an item in the component twice in rapid succession.	SelectableList
itemRollOut	Dispatched when the user rolls the pointer off of an item in the component.	SelectableList
itemRollOver	Dispatched when the user rolls the pointer over an item in the component.	SelectableList
keyDown	Dispatched when the user presses a key.	InteractiveObject
keyFocusChange	Dispatched when the user attempts to change focus by using keyboard navigation.	InteractiveObject
keyUp	Dispatched when the user releases a key.	InteractiveObject
middleClick	Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.	InteractiveObject
middleMouseDown	Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.	InteractiveObject
middleMouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseDown	Dispatched when a user presses the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseFocusChange	Dispatched when the user attempts to change focus by using a pointer device.	InteractiveObject
mouseMove	Dispatched when a user moves the pointing device while it is over an InteractiveObject.	InteractiveObject
mouseOut	Dispatched when the user moves a pointing device away from an InteractiveObject instance.	InteractiveObject
mouseOver	Dispatched when the user moves a pointing device over an InteractiveObject instance.	InteractiveObject
mouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseWheel	Dispatched when a mouse wheel is spun over an InteractiveObject instance.	InteractiveObject
move	Dispatched after the component is moved.	UIComponent
nativeDragComplete	Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.	InteractiveObject
nativeDragDrop	Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop().	InteractiveObject
nativeDragEnter	Dispatched by an InteractiveObject when a drag gesture enters its boundary.	InteractiveObject
nativeDragExit	Dispatched by an InteractiveObject when a drag gesture leaves its boundary.	InteractiveObject
nativeDragOver	Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary.	InteractiveObject
nativeDragStart	Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.	InteractiveObject
nativeDragUpdate	Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.	InteractiveObject
paste	Dispatched when the user activates the platform-specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu.	InteractiveObject
proximityBegin	Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen.	InteractiveObject
proximityEnd	Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen.	InteractiveObject
proximityMove	Dispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold.	InteractiveObject
proximityOut	Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen.	InteractiveObject
proximityOver	Dispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen.	InteractiveObject
proximityRollOut	Dispatched when the user moves an active stylus away from this InteractiveObject and any of its children while remaining within the proximity detection threshold of the screen.	InteractiveObject
proximityRollOver	Dispatched when the user moves an active stylus over this InteractiveObject from outside the object's tree of descendents in the display list (while remaining within the proximity detection threshold of the screen).	InteractiveObject
removed	Dispatched when a display object is about to be removed from the display list.	DisplayObject
removedFromStage	Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained.	DisplayObject
render	[broadcast event] Dispatched when the display list is about to be updated and rendered.	DisplayObject
resize	Dispatched after the component is resized.	UIComponent
rightClick	Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.	InteractiveObject
rightMouseDown	Dispatched when a user presses the pointing device button over an InteractiveObject instance.	InteractiveObject
rightMouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
rollOut	Dispatched when the user rolls the pointer off of the component.	SelectableList
rollOver	Dispatched when the user rolls the pointer over the component.	SelectableList
scroll	Dispatched when the user scrolls horizontally or vertically.	SelectableList
selectAll	Dispatched when the user activates the platform-specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu.	InteractiveObject
show	Dispatched after the component visibility changes from invisible to visible.	UIComponent
softKeyboardActivate	Dispatched immediately after the soft keyboard is raised.	InteractiveObject
softKeyboardActivating	Dispatched immediately before the soft keyboard is raised.	InteractiveObject
softKeyboardDeactivate	Dispatched immediately after the soft keyboard is lowered.	InteractiveObject
tabChildrenChange	Dispatched when the value of the object's tabChildren flag changes.	InteractiveObject
tabEnabledChange	Dispatched when the object's tabEnabled flag changes.	InteractiveObject
tabIndexChange	Dispatched when the value of the object's tabIndex property changes.	InteractiveObject
textInput	Dispatched when a user enters one or more characters of text.	InteractiveObject
touchBegin	Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen).	InteractiveObject
touchEnd	Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen).	InteractiveObject
touchMove	Dispatched when the user moves the point of contact with a touch-enabled device (such as drags a finger across a mobile phone or tablet with a touch screen).	InteractiveObject
touchOut	Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen).	InteractiveObject
touchOver	Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
touchRollOut	Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen).	InteractiveObject
touchRollOver	Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
touchTap	Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject

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

Click for more information on styles

Hide Inherited Styles

Show Inherited Styles

	Description	Defined By
cellRenderer	Type: Class The cell renderer to be used to render each item in the TileList component. The default value is `fl.controls.listClasses.ImageCell`.	TileList
contentPadding	Type: Number Format: Length The padding that separates the border of the list from its contents, in pixels.	SelectableList
disabledAlpha	Type: Number The alpha value to set the list to when the `enabled` property is `false`.	SelectableList
disabledTextFormat	Type: flash.text.TextFormat The TextFormat object to use to render the component label when the button is disabled.	UIComponent
downArrowDisabledSkin	Type: Class Name of the class to use as the skin for the down arrow button of the scroll bar when it is disabled.	BaseScrollPane
downArrowDownSkin	Type: Class Name of the class to use as the skin for the down arrow button of the scroll bar when you click the arrow button.	BaseScrollPane
downArrowOverSkin	Type: Class Name of the class to use as the skin for the down arrow button of the scroll bar when the mouse pointer is over the arrow button.	BaseScrollPane
downArrowUpSkin	Type: Class Name of the class to use as the skin for the down arrow button of the scroll bar.	BaseScrollPane
focusRectPadding	Type: Number Format: Length The padding that separates the outside boundaries of the component from the outside edges of the focus indicator, in pixels.	UIComponent
focusRectSkin	Type: Class The skin to be used to display focus indicators.	UIComponent
repeatDelay	Type: Number Format: Time The number of milliseconds to wait after the `buttonDown` event is first dispatched before sending a second `buttonDown` event.	BaseScrollPane
repeatInterval	Type: Number Format: Time The interval, in milliseconds, between `buttonDown` events that are dispatched after the delay that is specified by the `repeatDelay` style.	BaseScrollPane
skin	Type: Class The skin to be used as the background of the TileList component. The default value is `TileList_skin`.	TileList
textFormat	Type: flash.text.TextFormat The TextFormat object to use to render the component label.	UIComponent
thumbDisabledSkin	Type: Class The skin that is used to indicate the disabled state of the thumb.	BaseScrollPane
thumbDownSkin	Type: Class Name of the class to use as the skin for the thumb of the scroll bar when you click the thumb.	BaseScrollPane
thumbIcon	Type: Class Name of the class to use as the icon for the thumb of the scroll bar.	BaseScrollPane
thumbOverSkin	Type: Class Name of the class to use as the skin for the thumb of the scroll bar when the mouse pointer is over the thumb.	BaseScrollPane
thumbUpSkin	Type: Class Name of the class to use as the skin used for the thumb of the scroll bar.	BaseScrollPane
trackDisabledSkin	Type: Class The skin that is used to indicate a disabled track.	BaseScrollPane
trackDownSkin	Type: Class The skin that is used to indicate the down state of a disabled skin.	BaseScrollPane
trackOverSkin	Type: Class The skin that is used to indicate the mouseover state for the scroll track.	BaseScrollPane
trackUpSkin	Type: Class The skin used to indicate the mouse up state for the scroll track.	BaseScrollPane
upArrowDisabledSkin	Type: Class Name of the class to use as the skin for the up arrow button of the scroll bar when it is disabled.	BaseScrollPane
upArrowDownSkin	Type: Class Name of the class to use as the skin for the up arrow button of the scroll bar when you click the arrow button.	BaseScrollPane
upArrowOverSkin	Type: Class Name of the class to use as the skin for the up arrow button of the scroll bar when the mouse pointer is over the arrow button.	BaseScrollPane
upArrowUpSkin	Type: Class Name of the class to use as the skin for the up arrow button of the scroll bar.	BaseScrollPane

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		version : String = "3.0.3.1" The version number of the components.	UIComponent

Property Detail

columnCount

property

columnCount:uint

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets or sets the number of columns that are at least partially visible in the list. Setting the columnCount property changes the width of the list, but the TileList component does not maintain this value. It is important to set the columnCount value after setting the dataProvider and rowHeight values. The only exception is if the rowCount is set with the Property inspector; in this case, the property is maintained until the component is first drawn.

The default value is 0.

Implementation
public function get columnCount():uint
public function set columnCount(value:uint):void

Related API Elements

rowCount

Example ( How to use this example )

The following example creates a TileList component instance and resizes it by setting its columnCount and rowCount properties:


import fl.controls.TileList;
import fl.controls.ScrollBarDirection;

var myTileList:TileList = new TileList();
myTileList.addItem({label:"Image 1", source:"http://www.helpexamples.com/flash/images/image1.jpg"});
myTileList.addItem({label:"Image 2", source:"http://www.helpexamples.com/flash/images/image2.jpg"});
myTileList.addItem({label:"Image 3", source:"http://www.helpexamples.com/flash/images/image3.jpg"});
myTileList.direction = ScrollBarDirection.VERTICAL;
myTileList.columnWidth = 200;
myTileList.rowHeight = 134;
myTileList.columnCount = 1;
myTileList.rowCount = 2;
myTileList.move(10, 10);
addChild(myTileList);

columnWidth

property

columnWidth:Number

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets or sets the width that is applied to a column in the list, in pixels.

The default value is 50.

Implementation
public function get columnWidth():Number
public function set columnWidth(value:Number):void

Related API Elements

rowHeight

Example ( How to use this example )

The following example creates a TileList component instance and sets its columnWidth and rowHeight properties based on the value of a slider:


import fl.controls.Slider;
import fl.controls.TileList;
import fl.data.DataProvider;
import fl.events.SliderEvent;

var baseURL:String = "http://www.helpexamples.com/flash/images/";

var imagesXML:XML = <images>
        <img src="image1.jpg" alt="Image 1" />
        <img src="image2.jpg" alt="Image 2" />
        <img src="image3.jpg" alt="Image 3" />
    </images>;

var dp:DataProvider = new DataProvider(imagesXML);

var columnWidthSlider:Slider = new Slider();
columnWidthSlider.minimum = 50;
columnWidthSlider.maximum = 200;
columnWidthSlider.liveDragging = true;
columnWidthSlider.snapInterval = 10;
columnWidthSlider.tickInterval = 10;
columnWidthSlider.width = columnWidthSlider.maximum - columnWidthSlider.minimum;
columnWidthSlider.move(10, 10);
columnWidthSlider.addEventListener(SliderEvent.CHANGE, changeHandler);
addChild(columnWidthSlider);

var myTileList:TileList = new TileList();
myTileList.dataProvider = dp;
myTileList.labelField = "alt";
myTileList.sourceFunction = mySourceFunction;
myTileList.width = 530;
myTileList.rowCount = 1;
myTileList.move(10, 30);
addChild(myTileList);

function mySourceFunction(item:Object):String {
    return baseURL + item.src;
}

function changeHandler(event:SliderEvent):void {
    myTileList.columnWidth = event.value;
    myTileList.rowHeight = event.value;
    myTileList.rowCount = 1;
}

dataProvider

property

dataProvider:DataProvider[override]

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets or sets the data model of the list of items to be viewed. A data provider can be shared by multiple list-based components. Changes to the data provider are immediately available to all components that use it as a data source.

Implementation
override public function get dataProvider():DataProvider
override public function set dataProvider(value:DataProvider):void

Example ( How to use this example )

The following example creates a new TileList and adds items to its data provider using the addItem() method:


import fl.controls.TileList;
import fl.data.DataProvider;

var dp:DataProvider = new DataProvider();
dp.addItem({label:"Image 1", source:"http://www.helpexamples.com/flash/images/image1.jpg"});
dp.addItem({label:"Image 2", source:"http://www.helpexamples.com/flash/images/image2.jpg"});
dp.addItem({label:"Image 3", source:"http://www.helpexamples.com/flash/images/image3.jpg"});

var myTileList:TileList = new TileList();
myTileList.dataProvider = dp;
myTileList.columnWidth = 100;
myTileList.rowHeight = 100;
myTileList.columnCount = 2;
myTileList.rowCount = 2;
myTileList.move(10, 10);
addChild(myTileList);

The following example creates a new TileList and adds items to its data provider by passing an Array object to the DataProvider constructor:


import fl.controls.TileList;
import fl.data.DataProvider;

var itemsArray:Array = new Array();
itemsArray.push({label:"Image 1", source:"http://www.helpexamples.com/flash/images/image1.jpg"});
itemsArray.push({label:"Image 2", source:"http://www.helpexamples.com/flash/images/image2.jpg"});
itemsArray.push({label:"Image 3", source:"http://www.helpexamples.com/flash/images/image3.jpg"});

var dp:DataProvider = new DataProvider(itemsArray);

var myTileList:TileList = new TileList();
myTileList.dataProvider = dp;
myTileList.columnWidth = 100;
myTileList.rowHeight = 100;
myTileList.columnCount = 2;
myTileList.rowCount = 2;
myTileList.move(10, 10);
addChild(myTileList);

The following example creates a new TileList and adds items to its data provider by passing an XML object to the DataProvider constructor:


import fl.controls.TileList;
import fl.data.DataProvider;

var itemsXML:XML = <items>
        <item label="Image 1" source="http://www.helpexamples.com/flash/images/image1.jpg" />
        <item label="Image 2" source="http://www.helpexamples.com/flash/images/image2.jpg" />
        <item label="Image 3" source="http://www.helpexamples.com/flash/images/image3.jpg" />
    </items>;

var dp:DataProvider = new DataProvider(itemsXML);

var myTileList:TileList = new TileList();
myTileList.dataProvider = dp;
myTileList.columnWidth = 100;
myTileList.rowHeight = 100;
myTileList.columnCount = 2;
myTileList.rowCount = 2;
myTileList.move(10, 10);
addChild(myTileList);

direction

property

direction:String

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets or sets a value that indicates whether the TileList component scrolls horizontally or vertically. A value of ScrollBarDirection.HORIZONTAL indicates that the TileList component scrolls horizontally; a value of ScrollBarDirection.VERTICAL indicates that the TileList component scrolls vertically.

The default value is ScrollBarDirection.VERTICAL.

Implementation
public function get direction():String
public function set direction(value:String):void

Related API Elements

ScrollBarDirection

Example ( How to use this example )

The following example creates a TileList componenent instance and sets its scrolling direction to vertical:


import fl.controls.ScrollBarDirection;
import fl.controls.TileList;

var baseURL:String = "http://www.helpexamples.com/flash/images/";

var myTileList:TileList = new TileList();
myTileList.addItem({label:"Image 1", source:baseURL + "image1.jpg"});
myTileList.addItem({label:"Image 2", source:baseURL + "image2.jpg"});
myTileList.addItem({label:"Image 3", source:baseURL + "image3.jpg"});
myTileList.direction = ScrollBarDirection.VERTICAL;
myTileList.columnWidth = 100;
myTileList.rowHeight= 67;
myTileList.columnCount = 1;
myTileList.rowCount = 1;
myTileList.move(10, 10);
addChild(myTileList);

iconField

property

iconField:String

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets or sets the item field that provides the icon for the item.

Note: The iconField is not used if the iconFunction property is set to a callback function.

Icons can be classes or they can be symbols from the library that have a class name.

The default value is null.

Implementation
public function get iconField():String
public function set iconField(value:String):void

Related API Elements

iconFunction

Example ( How to use this example )

The following example creates an icon beside the label of each item in a tile list. The icon must be a symbol in the library named MyIcon with "Export for ActionScript" toggled in its symbol properties:

import fl.controls.TileList;
import fl.controls.listClasses.CellRenderer;

var baseURL:String = "http://www.helpexamples.com/flash/images/";

var myTileList:TileList = new TileList();
myTileList.addItem({src:baseURL + "image1.jpg", iconSrc:MyIcon });
myTileList.addItem({src:baseURL + "image2.jpg", iconSrc:MyIcon });
myTileList.addItem({src:baseURL + "image3.jpg", iconSrc:MyIcon });
myTileList.labelField = "src";
myTileList.labelFunction = myLabelFunction;
myTileList.setStyle('cellRenderer', CellRenderer);    
myTileList.iconField = "iconSrc";
myTileList.columnWidth = 100;
myTileList.rowHeight = 67;
myTileList.columnCount = myTileList.length;
myTileList.rowCount = 1;
myTileList.move(10, 10);
addChild(myTileList);

function myLabelFunction(item:Object):String {
    var fileName:String = item.src;
    var filePath:Array = fileName.split("/");
    return filePath.pop();
}

iconFunction

property

iconFunction:Function

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets or sets the function to be used to obtain the icon for the item.

Note: The iconField is not used if the iconFunction property is set to a callback function.

Icons can be classes, or they can be library items that have class names.

The default value is null.

Implementation
public function get iconFunction():Function
public function set iconFunction(value:Function):void

Related API Elements

iconField

Example ( How to use this example )

The following example creates an icon beside only the second item of a tile list by using a function to determine if image2.jpg is the source of the item. The icon must be a symbol in the library named MyIcon with "Export for ActionScript" toggled in its symbol properties:

import fl.controls.TileList;
import fl.controls.listClasses.CellRenderer;

var baseURL:String = "http://www.helpexamples.com/flash/images/";

var myTileList:TileList = new TileList();
myTileList.addItem({src:baseURL + "image1.jpg" });
myTileList.addItem({src:baseURL + "image2.jpg" });
myTileList.addItem({src:baseURL + "image3.jpg" });
myTileList.labelField = "src";
myTileList.labelFunction = myLabelFunction;
myTileList.setStyle('cellRenderer', CellRenderer);    
myTileList.iconFunction = myIconFunction;
myTileList.columnWidth = 100;
myTileList.rowHeight = 67;
myTileList.columnCount = myTileList.length;
myTileList.rowCount = 1;
myTileList.move(10, 10);
addChild(myTileList);

function myLabelFunction(item:Object):String {
    var fileName:String = item.src;
    var filePath:Array = fileName.split("/");
    return filePath.pop();
}

function myIconFunction(item:Object):Class {
    if(item.src == baseURL + "image2.jpg") {
        return MyIcon;
    }
    else {
        return null;
    }
}

innerHeight

property

innerHeight:Number [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets the height of the content area, in pixels. This value is the component height minus the combined height of the contentPadding value and horizontal scroll bar height, if the horizontal scroll bar is visible.

Implementation
public function get innerHeight():Number

Related API Elements

innerWidth

property

innerWidth:Number [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets the width of the content area, in pixels. This value is the component width minus the combined width of the contentPadding value and vertical scroll bar, if the vertical scroll bar is visible.

Implementation
public function get innerWidth():Number

Related API Elements

innerHeight

Example ( How to use this example )

The following example creates a TileList componenent instance and traces its innerWidth and innerHeight properties whenever the component's resize event is dispatched:


import fl.controls.ScrollBarDirection;
import fl.controls.TileList;
import fl.events.ComponentEvent;

var baseURL:String = "http://www.helpexamples.com/flash/images/";

var myTileList:TileList = new TileList();
myTileList.addItem({label:"Image 1", source:baseURL + "image1.jpg"});
myTileList.addItem({label:"Image 2", source:baseURL + "image2.jpg"});
myTileList.addItem({label:"Image 3", source:baseURL + "image3.jpg"});
myTileList.direction = ScrollBarDirection.VERTICAL;
myTileList.addEventListener(ComponentEvent.RESIZE, resizeHandler);
myTileList.columnWidth = 100;
myTileList.rowHeight= 67;
myTileList.columnCount = 1;
myTileList.rowCount = 1;
myTileList.move(10, 10);
addChild(myTileList);

function resizeHandler(event:ComponentEvent):void {
    var myTL:TileList =  event.currentTarget as TileList;
    trace("resize:");
    trace("\t" + "width:", myTL.width);
    trace("\t" + "height:", myTL.height);
    trace("\t" + "innerHeight:", myTL.innerHeight);
    trace("\t" + "innerWidth:", myTL.innerWidth);
}

labelField

property

labelField:String

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets or sets a field in each item that contains a label for each tile.

Note: The labelField is not used if the labelFunction property is set to a callback function.

The default value is "label".

Implementation
public function get labelField():String
public function set labelField(value:String):void

Related API Elements

labelFunction

Example ( How to use this example )

The following example creates a TileList component instance and sets the labelField and sourceField properties:


import fl.controls.TileList;
import fl.data.DataProvider;

var imagesXML:XML = <images>
        <img src="http://www.helpexamples.com/flash/images/image1.jpg" alt="Image 1" />
        <img src="http://www.helpexamples.com/flash/images/image2.jpg" alt="Image 2" />
        <img src="http://www.helpexamples.com/flash/images/image3.jpg" alt="Image 3" />
    </images>;

var dp:DataProvider = new DataProvider(imagesXML);

var myTileList:TileList = new TileList();
myTileList.dataProvider = dp;
myTileList.labelField = "alt";
myTileList.sourceField = "src";
myTileList.move(10, 10);
addChild(myTileList);

labelFunction

property

labelFunction:Function

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets a function that indicates the fields of an item that provide the label text for a tile.

Note: The labelField is not used if the labelFunction property is set to a callback function.

The default value is null.

Implementation
public function get labelFunction():Function
public function set labelFunction(value:Function):void

Related API Elements

labelField

Example ( How to use this example )

The following example creates a TileList component instance and creates a custom label function that returns the file name of the image being loaded:


import fl.controls.TileList;
import fl.data.DataProvider;

var imagesXML:XML = <images>
        <img src="http://www.helpexamples.com/flash/images/image1.jpg" />
        <img src="http://www.helpexamples.com/flash/images/image2.jpg" />
        <img src="http://www.helpexamples.com/flash/images/image3.jpg" />
    </images>;

var dp:DataProvider = new DataProvider(imagesXML);

var myTileList:TileList = new TileList();
myTileList.dataProvider = dp;
myTileList.labelFunction = myLabelFunction;
myTileList.sourceField = "src";
myTileList.columnWidth = 100;
myTileList.rowHeight = 67; 
myTileList.columnCount = 3;
myTileList.rowCount = 1;
myTileList.move(10, 10);
addChild(myTileList);

function myLabelFunction(item:Object):String {
    var fileName:String = item.src;
    var filePath:Array = fileName.split("/");
    return filePath.pop();
}

maxHorizontalScrollPosition

property

maxHorizontalScrollPosition:Number[override]

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets the maximum horizontal scroll position for the current content, in pixels.

Implementation
override public function get maxHorizontalScrollPosition():Number
override public function set maxHorizontalScrollPosition(value:Number):void

Related API Elements

fl.containers.BaseScrollPane.horizontalScrollPosition
fl.containers.BaseScrollPane.maxVerticalScrollPosition

rowCount

property

rowCount:uint[override]

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets or sets the number of rows that are at least partially visible in the list.

Setting the rowCount property changes the height of the list, but the TileList component does not maintain this value. It is important to set the rowCount value after setting the dataProvider and rowHeight values. The only exception is if the rowCount is set with the Property inspector; in this case, the property is maintained until the component is first drawn.

The default value is 0.

Implementation
override public function get rowCount():uint
override public function set rowCount(value:uint):void

Related API Elements

columnCount

Example ( How to use this example )

The following example creates a TileList component instance and sets the columnCount and rowCount properties to create a grid of images:


import fl.controls.TileList;
import fl.data.DataProvider;

var baseURL:String = "http://www.helpexamples.com/flash/images/gallery1/thumbnails/";

var imagesArray:Array = new Array();
var i:uint;
for (i = 20; i < 30; i++) {
    imagesArray.push({source:baseURL + "pic" + i + ".jpg", label:"Image " + i});
}

var dp:DataProvider = new DataProvider(imagesArray);

var myTileList:TileList = new TileList();
myTileList.dataProvider = dp;
myTileList.columnWidth = 150;
myTileList.rowHeight = 100; 
myTileList.columnCount = 3;
myTileList.rowCount = 2;
myTileList.move(10, 10);
addChild(myTileList);

rowHeight

property

rowHeight:Number

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets or sets the height that is applied to each row in the list, in pixels.

The default value is 50.

Implementation
public function get rowHeight():Number
public function set rowHeight(value:Number):void

Related API Elements

columnWidth

Example ( How to use this example )

The following example creates a TileList component instance and displays the specified images in a 2x2 grid:


import fl.controls.TileList;

var baseURL:String = "http://www.helpexamples.com/flash/images/";

var myTileList:TileList = new TileList();
myTileList.addItem({label:"Image 1", source:baseURL + "image1.jpg"});
myTileList.addItem({label:"Image 2", source:baseURL + "image2.jpg"});
myTileList.addItem({label:"Image 3", source:baseURL + "image3.jpg"});
myTileList.columnWidth = 100;
myTileList.rowHeight = 67;
myTileList.columnCount = 2;
myTileList.rowCount = 2;
myTileList.move(10, 10);
addChild(myTileList);

scrollPolicy

property

scrollPolicy:String

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets or sets the scroll policy for the TileList component. This value is used to specify the scroll policy for the scroll bar that is set by the direction property.

Note: The TileList component supports scrolling only in one direction. Tiles are adjusted to fit into the viewable area of the component, so that tiles are hidden in only one direction.

The TileList component resizes to fit tiles only when the user manually sets the size or when the user sets the rowCount or columnCount properties.

When this value is set to ScrollPolicy.AUTO, the scroll bar is visible only when the TileList component must scroll to show all the items.

The default value is ScrollPolicy.AUTO.

Implementation
public function get scrollPolicy():String
public function set scrollPolicy(value:String):void

Related API Elements

columnCount
rowCount
ScrollPolicy

Example ( How to use this example )

The following example creates a TileList component instance and sets the scrollPolicy to be always on:


import fl.controls.ScrollPolicy;
import fl.controls.TileList;

var baseURL:String = "http://www.helpexamples.com/flash/images/";

var myTileList:TileList = new TileList();
myTileList.addItem({label:"Image 1", source:baseURL + "image1.jpg"});
myTileList.addItem({label:"Image 2", source:baseURL + "image2.jpg"});
myTileList.addItem({label:"Image 3", source:baseURL + "image3.jpg"});
myTileList.columnWidth = 100;
myTileList.rowHeight = 67;
myTileList.scrollPolicy = ScrollPolicy.ON;
myTileList.columnCount = 4;
myTileList.rowCount = 1;
myTileList.move(10, 10);
addChild(myTileList);

sourceField

property

sourceField:String

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets or sets the item field that provides the source path for a tile.

Note: The sourceField is not used if the sourceFunction property is set to a callback function.

The default value is "source".

Implementation
public function get sourceField():String
public function set sourceField(value:String):void

Related API Elements

sourceFunction

Example ( How to use this example )

The following example creates a TileList component instance and sets the labelField and sourceField properties:


import fl.controls.ScrollPolicy;
import fl.controls.TileList;

var baseURL:String = "http://www.helpexamples.com/flash/images/";

var myTileList:TileList = new TileList();
myTileList.addItem({alt:"Image 1", src:baseURL + "image1.jpg"});
myTileList.addItem({alt:"Image 2", src:baseURL + "image2.jpg"});
myTileList.addItem({alt:"Image 3", src:baseURL + "image3.jpg"});
myTileList.labelField = "alt";
myTileList.sourceField = "src";
myTileList.columnWidth = 100;
myTileList.rowHeight = 67;
myTileList.columnCount = myTileList.length;
myTileList.rowCount = 1;
myTileList.move(10, 10);
addChild(myTileList);

sourceFunction

property

sourceFunction:Function

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets or sets the function to be used to obtain the source path for a tile.

Note: The sourceField is not used if the sourceFunction property is set to a callback function.

The default value is null.

Implementation
public function get sourceFunction():Function
public function set sourceFunction(value:Function):void

Related API Elements

sourceField

Example ( How to use this example )

The following example creates a TileList component instance and sets the sourceFunction property:


import fl.controls.ScrollPolicy;
import fl.controls.TileList;

var baseURL:String = "http://www.helpexamples.com/flash/images/";

var myTileList:TileList = new TileList();
myTileList.addItem({src:"image1.jpg"});
myTileList.addItem({src:"image2.jpg"});
myTileList.addItem({src:"image3.jpg"});
myTileList.labelField = "src";
myTileList.sourceFunction = mySourceFunction;
myTileList.columnWidth = 100;
myTileList.rowHeight = 67;
myTileList.columnCount = myTileList.length;
myTileList.rowCount = 1;
myTileList.move(10, 10);
addChild(myTileList);

function mySourceFunction(item:Object):String {
    return baseURL + item.src;
}

Constructor Detail

TileList

()

Constructor

public function TileList()

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Creates a new List component instance.

Method Detail

getStyleDefinition

()

method

public static function getStyleDefinition():Object

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Retrieves the default style map for the current component. The style map contains the type that is appropriate for the component, depending on the style that the component uses. For example, the disabledTextFormat style contains a value of null or a TextFormat object. You can use these styles and call setStyle() on the current component. The following code overrides the default disabledTextFormat style on the specified component:

componentInstance.setStyle("disabledTextFormat", new TextFormat());

Returns

Object — Default styles object.

Related API Elements

fl.core.UIComponent.getStyle()
fl.core.UIComponent.setStyle()
fl.managers.StyleManager

Example ( How to use this example )

The following example creates a style browser for several component classes:

import fl.controls.*;
import fl.containers.*;
import fl.controls.listClasses.*;
import fl.controls.dataGridClasses.*;
import fl.controls.progressBarClasses.*;
import fl.core.UIComponent;
import fl.data.DataProvider;

var dp:DataProvider = new DataProvider();
dp.addItem( { label: "BaseScrollPane",    data:BaseScrollPane } );
dp.addItem( { label: "Button",             data:Button } );
dp.addItem( { label: "CellRenderer",    data:CellRenderer } );
dp.addItem( { label: "CheckBox",         data:CheckBox } );
dp.addItem( { label: "ColorPicker",     data:ColorPicker } );
dp.addItem( { label: "ComboBox",         data:ComboBox } );
dp.addItem( { label: "DataGrid",         data:DataGrid } );
dp.addItem( { label: "HeaderRenderer",    data:HeaderRenderer } );
dp.addItem( { label: "ImageCell",        data:ImageCell } );
dp.addItem( { label: "IndeterminateBar",data:IndeterminateBar } );
dp.addItem( { label: "Label",             data:Label } );
dp.addItem( { label: "List",             data:List } );
dp.addItem( { label: "NumericStepper",     data:NumericStepper } );
dp.addItem( { label: "ProgressBar",     data:ProgressBar } );
dp.addItem( { label: "RadioButton",     data:RadioButton } );
dp.addItem( { label: "ScrollPane",         data:ScrollPane } );
dp.addItem( { label: "Slider",             data:Slider } );
dp.addItem( { label: "TextArea",         data:TextArea } );
dp.addItem( { label: "TextInput",         data:TextInput } );
dp.addItem( { label: "TileList",         data:TileList } );
dp.addItem( { label: "UILoader",         data:UILoader } );
dp.addItem( { label: "UIComponent",     data:UIComponent } );

var cb:ComboBox = new ComboBox();
cb.move(10,10);
cb.setSize(300,25);
cb.prompt = "Select a component to view its styles";
cb.rowCount = 12;
cb.dataProvider = dp;
cb.addEventListener(Event.CHANGE, showStyleDefinition);
addChild(cb);

var dg:DataGrid = new DataGrid();
dg.setSize(425,300);
dg.move(10,50);
dg.columns = [ new DataGridColumn("StyleName"), new DataGridColumn("DefaultValue") ];
addChild(dg);

function showStyleDefinition(e:Event):void {
    var componentClass:Class = e.target.selectedItem.data as Class;
    var styles:Object = componentClass["getStyleDefinition"].call(this);
    trace(styles.toString());
    var styleData:DataProvider = new DataProvider();
    for(var i:* in styles) {
        trace(i + " : " + styles[i]);
        styleData.addItem( { StyleName:i, DefaultValue:styles[i] } );
    }
    styleData.sortOn("StyleName");
    dg.dataProvider = styleData;
}

itemToLabel

()

method

override public function itemToLabel(item:Object):String

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Retrieves the string that the renderer displays for a given data object based on the labelField and labelFunction properties.

Parameters

item:Object — The Object to be rendered.

Returns

String — The string to be displayed based on the data.

Related API Elements

labelField
labelFunction

scrollToIndex

()

method

override public function scrollToIndex(newCaretIndex:int):void

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Scrolls the list to the item at the specified index. If the index is out of range, the scroll position does not change.

Parameters

newCaretIndex:int — The index location to scroll to.

Example ( How to use this example )

The following example creates a TileList component instance and uses a Slider component to scroll through the images:


import fl.controls.ScrollPolicy;
import fl.controls.Slider;
import fl.controls.TileList;
import fl.data.DataProvider;
import fl.events.SliderEvent;

var dp:DataProvider = new DataProvider();
dp.addItem({label:"Image 1", source:"http://www.helpexamples.com/flash/images/image1.jpg"});
dp.addItem({label:"Image 2", source:"http://www.helpexamples.com/flash/images/image2.jpg"});
dp.addItem({label:"Image 3", source:"http://www.helpexamples.com/flash/images/image3.jpg"});
dp.addItem({label:"Image 4", source:"http://www.helpexamples.com/flash/images/image1.jpg"});
dp.addItem({label:"Image 5", source:"http://www.helpexamples.com/flash/images/image2.jpg"});
dp.addItem({label:"Image 6", source:"http://www.helpexamples.com/flash/images/image3.jpg"});

var myTileList:TileList = new TileList();
myTileList.dataProvider = dp;
myTileList.scrollPolicy = ScrollPolicy.OFF;
myTileList.columnWidth = 100;
myTileList.rowHeight = 67;
myTileList.columnCount = 3;
myTileList.rowCount = 1;
myTileList.move(10, 10);
addChild(myTileList);

var mySlider:Slider = new Slider();
mySlider.liveDragging = true;
mySlider.minimum = 0;
mySlider.maximum = dp.length - 1;
mySlider.snapInterval = 1;
mySlider.tickInterval = 1;
mySlider.width = myTileList.width;
mySlider.move(myTileList.x, myTileList.y + myTileList.height + 10);
mySlider.addEventListener(SliderEvent.CHANGE, changeHandler);
addChild(mySlider);

function changeHandler(event:SliderEvent):void {
    myTileList.scrollToIndex(event.value);
}

Examples How to use this example

TileListExample.as

This example demonstrates how to create a TileList and dynamically populate its contents with a symbol in the library.

Add the TileList component to the library.
Draw a star and create a symbol from it named "star"
In the symbol properties for star, check the box that says "Export for ActionScript"
Save this code as TileListExample.as in the same directory as your FLA.
Set the DocumentClass in the FLA to TileListExample.

package
{ 
    import flash.display.Sprite;
    import flash.events.Event;
    import fl.data.DataProvider;
    import fl.controls.TileList;
    
    public class TileListExample extends Sprite
    {
        public function TileListExample() {
            var dp:DataProvider = new DataProvider();
            var totalEntries:uint = 42;
            var i:uint;
            for(i=0; i<totalEntries; i++) {
                dp.addItem( { label:"star"+i, source:star, scaleContent:false} );            
            }
            
            var myTileList = new TileList();
            myTileList.allowMultipleSelection = true;
            myTileList.columnWidth = 125;
            myTileList.rowHeight = 150;
            myTileList.dataProvider = dp;
            myTileList.setSize(300,300);
            myTileList.move(10,10);
            addChild(myTileList);
        }
    }
}

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

Classes x

columnCount

columnWidth

dataProvider

direction

iconField

iconFunction

innerHeight

innerWidth

labelField

labelFunction

maxHorizontalScrollPosition

rowCount

rowHeight

scrollPolicy

sourceField

sourceFunction

TileList

getStyleDefinition

itemToLabel

scrollToIndex