Package | mx.controls |
Class | public class TileList |
Inheritance | TileList TileBase ListBase ScrollControlBase UIComponent FlexSprite flash.display.Sprite |
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Starting with Flex 4.0, Apache recommends that you use the spark.components.List class as an alternative to this class.
The layout-specific List components in Flex 3 have been replaced by a more generic
List component that takes a generic layout. To get similar behavior from the new
List component, set the |
direction
property.
You can set the size of the tiles by using rowHeight
and columnWidth
properties.
Alternatively, Flex measures the item renderer for the first item
in the dataProvider and uses that size for all tiles.
The TileList control has the following default sizing characteristics:
Characteristic | Description |
---|---|
Default size | Four columns and four rows. Using the default item renderer, the total size is 66 by 126 pixels. |
Minimum size | 0 pixels. |
Maximum size | 5000 by 5000. |
The <mx:TileList>
tag inherits
all of the tag attributes of its superclass, but ignores the
variableRowHeight
and wordWrap
tag attributes.
It adds no additional tag attributes.
<mx:TileList/>
Default MXML PropertydataProvider
Method | Defined By | ||
---|---|---|---|
TileList()
Constructor. | TileList | ||
addDataEffectItem(item:Object):void
Adds an item renderer if a data change effect is running. | ListBase | ||
addStyleClient(styleClient:IAdvancedStyleClient):void
Adds a non-visual style client to this component instance. | UIComponent | ||
calculateDropIndex(event:DragEvent = null):int
Returns the index where the dropped items should be added
to the drop target. | ListBase | ||
callLater(method:Function, args:Array = null):void
Queues a function to be called later. | UIComponent | ||
clearStyle(styleProp:String):void
Deletes a style property from this component instance. | UIComponent | ||
contentToGlobal(point:Point):Point
Converts a Point object from content coordinates to global coordinates. | UIComponent | ||
contentToLocal(point:Point):Point
Converts a Point object from content to local coordinates. | UIComponent | ||
createAutomationIDPart(child:IAutomationObject):Object
Returns a set of properties that identify the child within
this container. | UIComponent | ||
createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object
Returns a set of properties as automation IDs that identify the child within
this container. | UIComponent | ||
createItemRenderer(data:Object):IListItemRenderer [override]
Get the appropriate renderer, using the default renderer if none is specified. | TileBase | ||
createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | ||
deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | ||
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | ||
dispatchEvent(event:Event):Boolean [override]
Dispatches an event into the event flow. | UIComponent | ||
drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component. | UIComponent | ||
drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object. | UIComponent | ||
effectFinished(effectInst:IEffectInstance):void
Called by the effect instance when it stops playing on the component. | UIComponent | ||
effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component. | UIComponent | ||
endEffectsStarted():void
Ends all currently playing effects on the component. | UIComponent | ||
executeBindings(recurse:Boolean = false):void
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | ||
findString(str:String):Boolean
Finds an item in the list based on a String,
and moves the selection to it. | ListBase | ||
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete. | UIComponent | ||
generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array | UIComponent | ||
generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):* | UIComponent | ||
getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index. | UIComponent | ||
getAutomationChildren():Array
Provides the automation object list . | UIComponent | ||
getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | ||
getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | ||
getClassStyleDeclarations():Array
Finds the type selectors for this UIComponent instance. | UIComponent | ||
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | ||
getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | ||
getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | ||
getFocus():InteractiveObject
Gets the object that currently has focus. | UIComponent | ||
getItemRendererFactory(data:Object):IFactory
Return the appropriate factory, using the default factory if none specified. | ListBase | ||
getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height. | UIComponent | ||
getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width. | UIComponent | ||
getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen. | UIComponent | ||
getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen. | UIComponent | ||
getLayoutMatrix():Matrix
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | ||
getLayoutMatrix3D():Matrix3D
Returns the layout transform Matrix3D for this element. | UIComponent | ||
getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height. | UIComponent | ||
getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width. | UIComponent | ||
getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height. | UIComponent | ||
getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width. | UIComponent | ||
getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height. | UIComponent | ||
getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width. | UIComponent | ||
getRendererSemanticValue(target:Object, semanticProperty:String):Object
Returns true or false
to indicates whether the effect should play on the target. | ListBase | ||
getRepeaterItem(whichRepeater:int = -1):Object
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | ||
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | ||
getVisibleRect(targetParent:DisplayObject = null):Rectangle
Get the bounds of this object that are visible to the user
on the screen. | UIComponent | ||
globalToContent(point:Point):Point
Converts a Point object from global to content coordinates. | UIComponent | ||
hasCSSState():Boolean
Returns true if currentCSSState is not null. | UIComponent | ||
hasState(stateName:String):Boolean
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | ||
hideDropFeedback(event:DragEvent):void
Hides the drop indicator under the mouse pointer that indicates that a
drag and drop operation is allowed. | ListBase | ||
horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | ||
indexToItemRenderer(index:int):IListItemRenderer
Get an item renderer for the index of an item in the data provider,
if one exists. | ListBase | ||
indicesToIndex(rowIndex:int, colIndex:int):int
Computes the offset into the data provider of the item
at colIndex, rowIndex. | ListBase | ||
initialize():void
Initializes the internal structure of this component. | UIComponent | ||
initializeRepeaterArrays(parent:IRepeaterClient):void
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | ||
invalidateDisplayList():void
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | ||
invalidateLayering():void
Called by a component's items to indicate that their depth
property has changed. | UIComponent | ||
invalidateLayoutDirection():void
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | ||
invalidateList():void
Refresh all rows on the next update. | ListBase | ||
invalidateProperties():void
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | ||
invalidateSize():void
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | ||
isItemHighlighted(data:Object):Boolean
Determines if the item renderer for a data provider item
is highlighted (is rolled over via the mouse or under the caret due to keyboard navigation). | ListBase | ||
isItemSelectable(data:Object):Boolean
Determines if the item renderer for a data provider item
is selectable. | ListBase | ||
isItemSelected(data:Object):Boolean
Determines if the item renderer for a data provider item
is selected. | ListBase | ||
isItemShowingCaret(data:Object):Boolean
Determines if the item renderer for a data provider item
is the item under the caret due to keyboard navigation. | ListBase | ||
isItemVisible(item:Object):Boolean
Determines if an item is being displayed by a renderer. | ListBase | ||
itemRendererContains(renderer:IListItemRenderer, object:DisplayObject):Boolean
Determines whether a renderer contains (or owns) a display object. | ListBase | ||
itemRendererToIndex(itemRenderer:IListItemRenderer):int
Returns the index of the item in the data provider of the item
being rendered by this item renderer. | ListBase | ||
itemToDataTip(data:Object):String
Returns the dataTip string the renderer would display for the given
data object based on the dataTipField and dataTipFunction properties. | ListBase | ||
itemToIcon(data:Object):Class
Returns the class for an icon, if any, for a data item,
based on the iconField and iconFunction properties. | ListBase | ||
itemToItemRenderer(item:Object):IListItemRenderer
Returns the item renderer for a given item in the data provider,
if there is one. | ListBase | ||
itemToLabel(data:Object):String
Returns the string the renderer would display for the given data object
based on the labelField and labelFunction properties. | ListBase | ||
localToContent(point:Point):Point
Converts a Point object from local to content coordinates. | UIComponent | ||
matchesCSSState(cssState:String):Boolean
Returns true if cssState matches currentCSSState. | UIComponent | ||
matchesCSSType(cssType:String):Boolean
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | ||
measureHeightOfItems(index:int = -1, count:int = 0):Number
Measures a set of items from the data provider using the
current item renderer and returns the sum of the heights
of those items. | ListBase | ||
measureHTMLText(htmlText:String):TextLineMetrics
Measures the specified HTML text, which can contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | ||
measureText(text:String):TextLineMetrics
Measures the specified text, assuming that it is displayed
in a single-line UITextField (or UIFTETextField) using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | ||
measureWidthOfItems(index:int = -1, count:int = 0):Number
Measures a set of items from the data provider using
the current item renderer and returns the
maximum width found. | ListBase | ||
move(x:Number, y:Number):void
Moves the component to a specified position within its parent. | UIComponent | ||
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children. | UIComponent | ||
owns(child:DisplayObject):Boolean
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | ||
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | ||
prepareToPrint(target:IFlexDisplayObject):Object
Prepares an IFlexDisplayObject for printing. | UIComponent | ||
regenerateStyleCache(recursive:Boolean):void
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well. | UIComponent | ||
registerEffects(effects:Array):void
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | ||
removeDataEffectItem(item:Object):void
Removes an item renderer if a data change effect is running. | ListBase | ||
removeStyleClient(styleClient:IAdvancedStyleClient):void
Removes a non-visual style client from this component instance. | UIComponent | ||
replayAutomatableEvent(event:Event):Boolean
Replays the specified event. | UIComponent | ||
resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided. | UIComponent | ||
resumeBackgroundProcessing():void [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | ||
scrollToIndex(index:int):Boolean
Ensures that the data provider item at the given index is visible. | ListBase | ||
setActualSize(w:Number, h:Number):void
Sizes the object. | UIComponent | ||
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | ||
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state. | UIComponent | ||
setFocus():void
Sets the focus to this component. | UIComponent | ||
setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen. | UIComponent | ||
setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element. | UIComponent | ||
setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | ||
setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | ||
setMXMLDescriptor(value:Array):void | UIComponent | ||
setMXMLProperties(value:Array):void | UIComponent | ||
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance. | UIComponent | ||
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes. | UIComponent | ||
showDropFeedback(event:DragEvent):void
Displays a drop indicator under the mouse pointer to indicate that a
drag and drop operation is allowed and where the items will
be dropped. | ListBase | ||
styleChanged(styleProp:String):void
Detects changes to style properties. | UIComponent | ||
stylesInitialized():void
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | ||
suspendBackgroundProcessing():void [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | ||
toString():String [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | ||
transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the
transform while keeping a particular point, specified in the component's
own coordinate space, fixed in the parent's coordinate space. | UIComponent | ||
transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. | UIComponent | ||
unconstrainRenderer(item:Object):void
Called by an UnconstrainItemAction effect
as part of a data change effect if the item renderers corresponding
to certain data items need to move outside the normal positions
of item renderers in the control. | ListBase | ||
validateDisplayList():void
Validates the position and size of children and draws other
visuals. | UIComponent | ||
validateNow():void
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | ||
validateProperties():void
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | ||
validateSize(recursive:Boolean = false):void
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | ||
validationResultHandler(event:ValidationResultEvent):void
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | ||
verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent |
Effect | Description | Defined By | ||
---|---|---|---|---|
Triggering Event: added Played when the component is added as a child to a Container. | UIComponent | |||
Triggering Event: creationComplete Played when the component is created. | UIComponent | |||
Triggering Event: focusIn Played when the component gains keyboard focus. | UIComponent | |||
Triggering Event: focusOut Played when the component loses keyboard focus. | UIComponent | |||
Triggering Event: hide Played when the component becomes invisible. | UIComponent | |||
itemsChangeEffect | Triggering Event: itemsChange The data effect to play when a change occur to the control's data provider. By default, the TileList control does not use a data effect. For the TileList control, use an instance of the DefaultTileListEffect class. | TileList | ||
Triggering Event: mouseDown Played when the user presses the mouse button while over the component. | UIComponent | |||
Triggering Event: mouseUp Played when the user releases the mouse button while over the component. | UIComponent | |||
Triggering Event: move Played when the component is moved. | UIComponent | |||
Triggering Event: removed Played when the component is removed from a Container. | UIComponent | |||
Triggering Event: resize Played when the component is resized. | UIComponent | |||
Triggering Event: rollOut Played when the user rolls the mouse so it is no longer over the component. | UIComponent | |||
Triggering Event: rollOver Played when the user rolls the mouse over the component. | UIComponent | |||
Triggering Event: show Played when the component becomes visible. | UIComponent |
TileList | () | Constructor |
public function TileList()
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Constructor.
<?xml version="1.0" encoding="utf-8"?> <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> <!-- Simple example to demonstrate the Halo TileList Control. --> <s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" xmlns:s="library://ns.adobe.com/flex/spark" xmlns:mx="library://ns.adobe.com/flex/mx"> <fx:Script> <![CDATA[ [Embed(source="assets/Product1.png")] public const phone1:Class; [Embed(source="assets/Product2.png")] public const phone2:Class; [Embed(source="assets/Product3.png")] public const phone3:Class; [Embed(source="assets/Product4.png")] public const phone4:Class; [Embed(source="assets/Product5.png")] public const phone5:Class; ]]> </fx:Script> <s:Panel title="Halo TileList Control Example" width="75%" height="75%" horizontalCenter="0" verticalCenter="0"> <s:VGroup left="10" right="10" top="10" bottom="10"> <s:Label width="100%" color="blue" text="A TileList control displays items in rows and columns."/> <mx:TileList id="CameraSelection" height="250" width="300" maxColumns="2" rowHeight="225" columnWidth="125"> <mx:dataProvider> <fx:Array> <fx:Object label="Product 1" icon="{phone1}"/> <fx:Object label="Product 2" icon="{phone2}"/> <fx:Object label="Product 3" icon="{phone3}"/> <fx:Object label="Product 4" icon="{phone4}"/> <fx:Object label="Product 5" icon="{phone5}"/> </fx:Array> </mx:dataProvider> </mx:TileList> </s:VGroup> </s:Panel> </s:Application>