"NOVEMBER 2008
Adobe Flash Platform ActionScript Reference Rich Internet Application Development
® ® ®
Adobe Flash Player 10 / Adobe Flex® 3.2 / Adobe AIR™ 1.5
Class / Interface ● Adobe AIR ■ Adobe Flex p: Package k Extends Implements Property Static Property Method Static Method
Adobe Flash Platform / ActionScript Reference / Rich Internet Application Development
Table of Contents:About This Guide:How to Use This Guide
Table of Contents 2 3 4–5 6 – 57 Back About this guide How to Use This Guide Adobe Flash Platform for RIAs ActionScript reference guide Quick URL reference
About this guide
This guide provides a reference for all native ActionScript APIs for the Adobe Flash Platform runtimes, Adobe Flash Player, Adobe AIR, and the Flex framework. It contains an alphabetical listing of all the ActionScript APIs as well as additional references and resources. Before you get started, download the latest version of the free Adobe runtimes and frameworks: Adobe Flash Player www.adobe.com/go/getflashplayer Adobe AIR www.adobe.com/go/air Adobe Flex www.adobe.com/go/flex
How to Use This Guide
This guide can be used both as an API reference, as well as a tool to quickly learn about the ActionScript APIs available within Adobe Flash Player, Adobe AIR, and the Adobe Flex framework. To use the guide as a reference guide, just follow these steps: Step 1 : Find the class All of the classes are included in alphabetical order, with the alphabetical range of each page shown in the top right of the page. Simply leaf through the guide, using the Class/Interface name as a reference, to find the item you are looking for. Step 2 : Read the information Each item entry contains the complete API reference for that item. Each entry is formatted to make it easy to quickly scan the item and view its information. The entry contains a wealth of information about the item including name, type (class or interface), package name, superclass, interfaces implemented as well as a complete API listing, including static and instance properties and methods.
Understanding Where APIs can be used: The Adobe Flash platform contains two primary runtimes. One, Adobe Flash Player is browser based, and the other, Adobe AIR is desktop based. Adobe AIR is built on top of the Flash Player, so Flash Player APIs are available within Adobe AIR. In addition, this means that Adobe AIR APIs are not available within the Flash Player. The Flex framework is built on top of Flash Player APIs, and thus it runs in both the player and Adobe AIR. However, a number of Flex APIs take advantage of AIR APIs, and thus only work within Adobe AIR. Each entry contains icons to indicate where the API can be used. The icon shows where the API originates, and thus in which runtime the API will run. No Icon : Originates in Flash Player, and is available in the Flash Player, Adobe AIR and the Flex Framework. Red Icon Only: ● Originates in Adobe AIR, and cannot run in Flash Player. Black Icon Only : ■ Originates in Flex Framework and runs in Flash Player and Adobe AIR. Black Icon and Red Icon : ■● Flex API that only runs in Adobe AIR. Examples of classes from this guide: FileReference Originates in Flash Player and will run in Flash Player and Adobe AIR. File ● Originates in Adobe AIR, and will not run in Flash Player. Fade ■ Originates in Flex Framework and will run in Flash Player and Adobe AIR. FileSystemTree ■● Originates in Flex Framework, but uses Adobe AIR APIs. Will run in Adobe AIR, but not in Flash Player. Step 3 : Find more information If you still need to find more information about an API, you can either look at the API for the subclass of the item in the reference guide, or look up the API in the online documentation. You can find the links to the online documentation on the back cover of the reference guide.
58 - 59 Notes
Class / Interface ● Adobe AIR ■ Adobe Flex p: Package k Extends Implements Property Static Property Method Static Method
Lets look at the ArrayCollection entry:
ArrayCollection ■ p: cd mx.collections k ListCollectionView IExternalizable
source: Array ArrayCollection()
©2008 Adobe Systems Incorporated. All rights reserved. Adobe, the Adobe logo, ActionScript, Acrobat, Acrobat Connect, Adobe AIR, the Adobe AIR logo, the Adobe Flash logo, Adobe Premiere, After Effects, Buzzword, ColdFusion, Creative Suite, Dreamweaver, Fireworks, Flash, Flex, Flex Builder, Kuler, Illustrator, Photoshop, LiveCycle are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. 2
This work is released under a Creative Commons Attribution-Noncommercial 3.0 Unported License. http: //creativecommons.org/licenses/by-nc/3.0
This item is a class named ArrayCollection, which extends the ListCollectionView class, and implements the IExternalizable interface. It can be found in the mx.collections package, and originates in the Flex framework and runs in Flash Player and Adobe AIR.
3
Adobe Flash Platform / ActionScript Reference / Rich Internet Application Development
Adobe Flash Platform for RIAs
Adobe Flash Platform for RIAs
Adobe Photoshop® Express Adobe Premeire® Express Adobe Acrobat® Connect™
Adobe Media Player
Adobe Buzzword®
Adobe Kuler™
Rich Internet Applications
Content and Applications Tooling
Rich Content
Client Framework
Adobe Flex
MXML
ActionScript Adobe Flex Builder Adobe Flex SDK
Browser
Adobe Flash Player
ActionScript
Runtimes
Desktop
Adobe AIR
JavaScript
PDF
ActionScript
HTML, CSS, etc.
Adobe Dreamweaver ®
Adobe Flash Professional
Adobe Flash Catalyst™
Operating Systems
Mac, Windows® Linux® and others , ,
XML, JSON, SOAP, RSS, ATOM, AMF, etc.
HTTP, HTTPS, Raw Sockets, RTMP
Adobe Photoshop Adobe Illustrator ® Adobe Premeire Pro
Client Server
Server
Adobe Scene7
Adobe ColdFusion®
Adobe LiveCycle® ES
Adobe Flash Media Server 3
Adobe After Effects®
Adobe Acrobat® Pro
Adobe Fireworks®
ASP.NET, PHP, Java®, Python, etc.
4
Web Services Adobe Services
5
Adobe Flash Platform / ActionScript Reference / Rich Internet Application Development
AbstractEvent – AdvancedDataGridItemRenderer
AbstractEvent ■ p: mx.rpc.events k MessageEvent
token:AsyncToken
AbstractConsumer ■ p: mx.messaging k MessageAgent
AbstractTarget ■ p: mx.logging k Object ILoggingTarget IMXMLObject
filters:Array id:String level:int AbstractTarget() addLogger():void initialized():void logEvent():void removeLogger():void
AccordionAutomationImpl ■ p: mx.automation.delegates. containers k ContainerAutomationImpl
AddChildActionInstance ■ p: mx.effects.effectClasses k ActionEffectInstance
AccordionAutomationImpl() init():void replayAutomatableEvent():Boolean
index:int position:String relativeTo:DisplayObjectContainer AddChildActionInstance()
AdvancedDataGridBase ■ p: mx.controls.advancedData k AdvancedListBaseGridClasses
resubscribeAttempts:int resubscribeInterval:int subscribed:Boolean timestamp:Number AbstractConsumer():void disconnect():void receive():void subscribe():void unsubscribe():void
AccordionHeader ■ p: mx.containers.accordionClasses k Button IDataRenderer
data:Object AccordionHeader()
AddItemAction ■ p: mx.effects k Effect AddItemActionInstance ■ p: mx.effects.effectClasses k ActionEffectInstance AdvancedDataGrid ■ p: mx.controls k AdvancedDataGridBaseEx
AbstractWebService ■ p: mx.rpc.soap k AbstractService
AbstractInvoker ■ p: mx.rpc k EventDispatcher
lastResult:Object makeObjectsBindable:Boolean cancel():AsyncToken clearResult():void
AbstractMessage ■ p: mx.messaging.messages k Object IMessage
body:Object clientId:String destination:String DESTINATION_CLIENT_ID_ HEADER:String ENDPOINT_HEADER:String FLEX_CLIENT_ID_HEADER:String headers:Object messageId:String REMOTE_CREDENTIALS_CHARSET_ HEADER:String REMOTE_CREDENTIALS_ HEADER:String REQUEST_TIMEOUT_HEADER:String timestamp:Number timeToLive:Number AbstractMessage() toString():String
DEFAULT_DESTINATION_HTTP:String DEFAULT_DESTINATION_HTTPS:String description:String destination:String endpointURI:String headers:Array httpHeaders:Object makeObjectsBindable:Boolean port:String ready:Boolean rootURL:String service:String useProxy:Boolean xmlSpecialCharsFilter:Function AbstractWebService() addHeader():void addSimpleHeader():void clearHeaders():void getHeader():SOAPHeader removeHeader():void setRemoteCredentials():void
AccordionHeaderSkin ■ p: mx.skins.halo k Border AcknowledgeMessage ■ p: mx.messaging.messages k AsyncMessage
ERROR_HINT_HEADER:String AcknowledgeMessage()
ActionEffectInstance ■ p: mx.effects.effectClasses k EffectInstance
playedAction:Boolean ActionEffectInstance() getStartValue():* saveStartValue():*
ActionScriptVersion p: flash.display k Object
ACTIONSCRIPT2:uint ACTIONSCRIPT3:uint
Accessibility p: flash.accessibility k Object
ActivatorSkin ■ p: mx.skins.halo k Border ActivityEvent p: flash.events k Event
active:Boolean updateProperties():void
AccessibilityProperties p: flash.accessibility k Object
description:String forceSimple:Boolean name:String noAutoLabeling:Boolean shortcut:String silent:Boolean AccessibilityProperties()
AbstractOperation ■ p: mx.rpc k AbstractInvoker
arguments:Object name:String service:AbstractService AbstractOperation() send():AsyncToken
activating:Boolean ACTIVITY:String ActivityEvent() clone():Event toString():String
AddChild ■ p: mx.states k Object
AbstractService ■ p: mx.rpc k Proxy IEventDispatcher
channelSet:ChannelSet destination:String operations:Object requestTimeout:int AbstractService() disconnect():void getOperation():AbstractOperation logout():void setCredentials():void setRemoteCredentials():void
Accordion ■ p: mx.containers k Container IHistoryManagerClient IFocusManagerComponent
contentHeight:Number contentWidth:Number headerRenderer:IFactory historyManagementEnabled:Boolean resizeToContent:Boolean selectedChild:Container selectedIndex:int Accordion() getHeaderAt():Button loadState():void saveState():Object
creationPolicy:String position:String relativeTo:UIComponent target:DisplayObject targetFactory:IDeferredInstance AddChild() apply():void createInstance():void initialize():void remove():void
AddChildAction ■ p: mx.effects k Effect IOverride
index:int position:String relativeTo:DisplayObjectContainer AddChildAction()
anchorColumnIndex:int caretColumnIndex:int cellSelectionTweens:Object displayDisclosureIcon:Boolean displayItemsExpanded:Boolean firstVisibleItem:Object groupedColumns:Array groupIconFunction:Function groupItemRenderer:IFactory groupLabelFunction:Function groupRowHeight:Number HEADER_ICON_PART:String HEADER_TEXT_PART:String hierarchicalCollectionView:IHierarchica lCollectionView highlightColumnIndex:int itemIcons:Object lockedColumnCount:int lockedRowCount:int movingSelectionLayer:Sprite rendererProviders:Array selectedCells:Array selectedColumnIndex:int sortExpertMode:Boolean treeColumn:AdvancedDataGridColumn treeColumnIndex:int tween:Object visibleCellRenderers:Object addCellSelectionData():void addIndicatorToSelectionLayer():void AdvancedDataGrid() applyCellSelectionEffect():void applyUserStylesForItemRenderer():void atLeastOneProperty():Boolean clearCellSelectionData():void clearIndicators():void clearSelectedCells():void collapseAll():void createChildren():void dragCompleteHandler():void dragDropHandler():void drawVerticalLine():void expandAll():void expandChildrenOf():void expandItem():void finishKeySelection():void getParentItem():* initListData():void isItemOpen():Boolean moveIndicators():void removeCellSelectionData():void selectCellItem():Boolean selectItem():Boolean setItemIcon():void treeNavigationHandler():Boolean
columnMap:Object currentColNum:int currentItemTop:Number currentRowHeight:Number currentRowNum:int headerHeight:Number headerInfos:Array headerRenderer:IFactory headerRowInfo:Array headerWordWrap:Boolean itemRendererToFactoryMap:Dictionary MULTIPLE_CELLS:String MULTIPLE_ROWS:String NONE:String selectionMode:String showHeaders:Boolean SINGLE_CELL:String SINGLE_ROW:String sortItemRenderer:IFactory styleFunction:Function visibleHeaderInfos:Array AdvancedDataGridBase() calculateRowHeight():Number clearIndicators():void createHeaders():void createLockedRows():void drawVisibleItem():void getHeaderRenderer():IListItemRen derer getRowHeight():Number isCellSelectionMode():Boolean isRowSelectionMode():Boolean makeListData():BaseListData setVisibleDataItem():void
resizableColumns:Boolean sortableColumns:Boolean absoluteToDisplayColumnIndex():int absoluteToVisibleColumnIndex():int absoluteToVisibleIndices():Object addSortField():void AdvancedDataGridBaseEx() clearSeparators():void colNumToIndex():int createHeaderSeparators():void createItemEditor():void destroyItemEditor():void displayToAbsoluteColumnIndex():int drawColumnBackground():void drawHeaderBackground():void drawHorizontalLine():void drawLinesAndColumnBackgrounds( ):void drawRowBackground():void drawSeparators():void drawVerticalLine():void findSortField():int getFieldSortInfo():SortInfo getSeparator():UIComponent indexToColNum():int isColumnFullyVisible():Boolean isDataEditable():Boolean moveFocusToHeader():void removeSortField():void scrollToViewColumn():void selectColumnHeader():void unselectColumnHeader():void visibleToAbsoluteColumnIndex():int
visible:Boolean width:Number wordWrap:* AdvancedDataGridColumn() clone():AdvancedDataGridColumn itemToDataTip():String itemToLabel():String
listData:BaseListData AdvancedDataGridGroupItemRenderer()
AdvancedDataGridColumnGroup ■ p: mx.controls.advanced DataGridClasses kAdvancedDataGridColumn
children:Array childrenDragEnabled:Boolean AdvancedDataGridColumnGroup() itemToData():*
AdvancedDataGridGroupItem RendererAutomationImpl ■ p: mx.automation.delegates. advancedDataGrid k UIComponentAutomationImpl
AdvancedDataGridGroupItemRenderer AutomationImpl() init():void
AdvancedDataGridDragProxy ■ p: mx.controls.advanced k UIComponent DataGridClasses AdvancedDataGridEvent ■ p: mx.events k Event
AdvancedDataGridHeader HorizontalSeparator ■ p: mx.skins.halo k ProgrammaticSkin AdvancedDataGridHeaderInfo ■ p: mx.controls.advanced k DataGridClasses
actualColNum:int children:Array column:AdvancedDataGridColumn columnSpan:int depth:int headerItem:IListItemRenderer index:int internalLabelFunction:Function parent:AdvancedDataGridHeaderInfo visible:Boolean visibleChildren:Array visibleIndex:int AdvancedDataGridHeaderInfo()
AdvancedDataGridAutomation Impl ■ p: mx.automation.delegates. advancedDataGrid k AdvancedDataGridBaseEx AutomationImpl
automationTabularData:Object AdvancedDataGridAutomationImpl() init():void
AdvancedDataGridBaseSelection Data ■ p: mx.controls.advanced k Object
approximate:Boolean columnIndex:int data:Object rowIndex:int AdvancedDataGridBaseSelectionData()
AdvancedDataGridBaseEx AutomationImpl ■ p: mx.automation.delegates. advancedDataGrid k AdvancedListBaseAutomation Impl
AdvancedDataGridBaseExAutomation Impl() init():void
AdvancedDataGridColumn ■ p: mx.controls.advancedData GridClasses k CSSStyleDeclaration IIMESupport
dataField:String dataTipField:String dataTipFunction:Function editable:Boolean editorDataField:String editorHeightOffset:Number editorUsesEnterKey:Boolean editorWidthOffset:Number editorXOffset:Number editorYOffset:Number formatter:Formatter headerRenderer:IFactory headerText:String headerWordWrap:* imeMode:String itemEditor:IFactory itemRenderer:IFactory labelFunction:Function minWidth:Number rendererIsEditor:Boolean resizable:Boolean showDataTips:* sortable:Boolean sortCompareFunction:Function sortDescending:Boolean styleFunction:Function
animate:Boolean column:AdvancedDataGridColumn COLUMN_STRETCH:String columnIndex:int dataField:String dispatchEvent:Boolean HEADER_DRAG_OUTSIDE:String HEADER_DROP_OUTSIDE:String HEADER_RELEASE:String headerPart:String item:Object ITEM_CLOSE:String ITEM_EDIT_BEGIN:String ITEM_EDIT_BEGINNING:String ITEM_EDIT_END:String ITEM_FOCUS_IN:String ITEM_FOCUS_OUT:String ITEM_OPEN:String ITEM_OPENING:String itemRenderer:IListItemRenderer localX:Number multiColumnSort:Boolean opening:Boolean reason:String removeColumnFromSort:Boolean rowIndex:int triggerEvent:Event AdvancedDataGridEvent()
AdvancedDataGridHeader Renderer ■ p: mx.controls.advancedData GridClasses k UIComponent IDataRenderer IDropInListItemRenderer IListItemRenderer
data:Object label:IUITextField listData:BaseListData sortItemRenderer:IFactory AdvancedDataGridHeaderRenderer() getFieldSortInfo():SortInfo mouseEventToHeaderPart():String toolTipShowHandler():void
AdvancedDataGridEventReason ■ p: mx.events k Object
CANCELLED:String NEW_COLUMN:String NEW_ROW:String OTHER:String
AdvancedDataGridHeaderShift Event ■ p: mx.automation.events k Event
AdvancedDataGridBaseEx ■ p: mx.controls k AdvancedDataGridBase IIMESupport
columns:Array draggableColumns:Boolean editable:String editedItemPosition:Object editedItemRenderer:IListItemRenderer headerInfoInitialized:Boolean horizontalScrollPosition:Number imeMode:String isKeyPressed:Boolean itemEditorInstance:IListItemRenderer lookAheadDuration:Number minColumnWidth:Number orderedHeadersList:Array
AdvancedDataGridGroupItem Renderer ■ p: mx.controls.advancedData GridClasses k UIComponent IDataRenderer IDropInListItemRenderer IListItemRenderer IFontContextComponent
data:Object disclosureIcon:IFlexDisplayObject icon:IFlexDisplayObject label:IUITextField
itemAutomationValue:String HEADER_RELEASE:String = “headerRelease” movingColumnIndex:int newColumnIndex:int oldColumnIndex:int triggerEvent:Event AdvancedDataGridHeaderShiftEvent()
AdvancedDataGridItemRenderer ■ p: mx.controls.advancedData GridClasses k UITextField IDataRenderer, IDropInListItemRenderer ILayoutManagerClient IListItemRenderer IStyleClient
6
7
Adobe Flash Platform / ActionScript Reference / Rich Internet Application Development
AdvancedDataGridItemRendererAutomationImpl – AuthenticationMethod
data:Object listData:BaseListData styleDeclaration:CSSStyleDeclaration AdvancedDataGridItemRenderer() clearStyle():void getClassStyleDeclarations():Array getStyle():* initProtoChain():void notifyStyleChangeInChildren():void regenerateStyleCache():void registerEffects():void setStyle():void toolTipShowHandler():void validateDisplayList():void validateProperties():void validateSize():void
dataField:String depth:int renderer:IFactory rowSpan:int AdvancedDataGridRendererProvider() describeRendererForItem():void
AdvancedDataGridSortItem Renderer ■ p: mx.controls.advancedData GridClasses k UIComponent
grid:AdvancedDataGrid label:IUITextField AdvancedDataGridSortItemRenderer() getFieldSortInfo():SortInfo getFontStyles():void
AdvancedDataGridItem RendererAutomationImpl ■ p: mx.automation.delegates k UITextFieldAutomationImpl advancedDataGrid
AdvancedDataGridItemRenderer AutomationImpl() init():void
AdvancedDataGridItemSelect Event ■ p: mx.automation.events k Event
AdvancedListBase ■ p: mx.controls.listClasses k ScrollControlBase IDataRenderer IFocusManagerComponent IListItemRenderer IDropInListItemRenderer IEffectTargetHost
actualCollection:ICollectionView actualIterator:IViewCursor allowDragSelection:Boolean allowMultipleSelection:Boolean anchorBookmark:CursorBookmark anchorIndex:int cachedDataChangeEffect:Effect caretBookmark:CursorBookmark caretIndex:int caretIndicator:Sprite caretItemRenderer:IListItemRenderer caretUID:String collection:ICollectionView columnCount:int columnWidth:Number data:Object dataEffectCompleted:Boolean dataItemWrappersByRenderer:Dict ionary dataProvider:Object dataTipField:String dataTipFunction:Function defaultColumnCount:int defaultRowCount:int dragEnabled:Boolean dragImage:IUIComponent dragImageOffsets:Point dragMoveEnabled:Boolean dropEnabled:Boolean explicitColumnCount:int explicitColumnWidth:Number explicitRowCount:int explicitRowHeight:Number freeItemRenderers:Array highlightIndicator:Sprite highlightItemRenderer:IListItemRen derer highlightUID:String iconField:String i..."
|
You need to upgrade your Flash Player , or try to enable javascript in order see this document properly.
|
|