/frameworks/projects/playerglobal/bundles/en_US/docs/flash.display.xml
XML | 3614 lines | 3025 code | 571 blank | 18 comment | 0 complexity | 6a674eb57b74f902e3c15f3c167b0dd9 MD5 | raw file
Possible License(s): Apache-2.0
- <?xml version="1.0" encoding="UTF-8"?><apiPackage xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" id="flash.display" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiPackage/apiPackage "><apiName class="- topic/title reference/title apiRef/apiName ">flash.display</apiName><apiDetail class="- topic/body reference/refbody apiRef/apiDetail "/><apiClassifier languages="" id="flash.display:FrameLabel" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">FrameLabel</apiName><shortdesc class="- topic/shortdesc ">
- <!--
- 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.
- -->
-
- The FrameLabel object contains properties that specify a frame number and the
- corresponding label name.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
-
- The FrameLabel object contains properties that specify a frame number and the
- corresponding label name.
- The Scene class includes a <codeph class="+ topic/ph pr-d/codeph ">labels</codeph> property, which is an array
- of FrameLabel objects for the scene.
-
- </apiDesc></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.display.xml#Scene/labels" class="- topic/link "><linktext class="- topic/linktext ">Scene.labels</linktext></link><link href="flash.display.xml#MovieClip/currentLabel" class="- topic/link "><linktext class="- topic/linktext ">MovieClip.currentLabel</linktext></link><link href="flash.display.xml#MovieClip/currentScene" class="- topic/link "><linktext class="- topic/linktext ">MovieClip.currentScene</linktext></link><link href="flash.display.xml#MovieClip/scenes" class="- topic/link "><linktext class="- topic/linktext ">MovieClip.scenes</linktext></link><link href="flash.display.xml#MovieClip/gotoAndPlay()" class="- topic/link "><linktext class="- topic/linktext ">MovieClip.gotoAndPlay()</linktext></link><link href="flash.display.xml#MovieClip/gotoAndStop()" class="- topic/link "><linktext class="- topic/linktext ">MovieClip.gotoAndStop()</linktext></link></related-links><apiValue id="flash.display:FrameLabel:frame:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">frame</apiName><shortdesc class="- topic/shortdesc ">
- The frame number containing the label.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">int</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- The frame number containing the label.
- </apiDesc></apiValueDetail></apiValue><apiValue id="flash.display:FrameLabel:name:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">name</apiName><shortdesc class="- topic/shortdesc ">
- The name of the label.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- The name of the label.
- </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier languages="" id="flash.display:InteractiveObject" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">InteractiveObject</apiName><shortdesc class="- topic/shortdesc ">
- The InteractiveObject class is the abstract base class for all display objects with which the user can
- interact, using the mouse, keyboard, or other user input device.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">flash.display:DisplayObject</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- The InteractiveObject class is the abstract base class for all display objects with which the user can
- interact, using the mouse, keyboard, or other user input device.
-
- <p class="- topic/p ">You cannot instantiate the InteractiveObject class directly. A call to the <codeph class="+ topic/ph pr-d/codeph ">new
- InteractiveObject()</codeph> constructor throws an <codeph class="+ topic/ph pr-d/codeph ">ArgumentError</codeph> exception.</p>
-
- <p class="- topic/p ">The InteractiveObject class itself does not include any APIs for rendering content onscreen.
- To create a custom subclass of the InteractiveObject class,
- extend one of the subclasses that do have APIs for rendering content onscreen,
- such as the Sprite, SimpleButton, TextField, or MovieClip classes.</p>
-
- </apiDesc><example conref="examples\InteractiveObjectExample.as" class="- topic/example "> The following example uses the <codeph class="+ topic/ph pr-d/codeph ">InteractiveObjectExample</codeph> class, which in
- turn uses the <codeph class="+ topic/ph pr-d/codeph ">ChildSprite</codeph> class to draw a rectangle and then manipulate that rectangle
- based on various mouse events. This task is accomplished by performing the following steps:
- <ol class="- topic/ol "><li class="- topic/li ">In the <codeph class="+ topic/ph pr-d/codeph ">InteractiveObjectExample</codeph> constructor, a new ChildSprite object of type Sprite
- called <codeph class="+ topic/ph pr-d/codeph ">child</codeph> is created, which calls the ChildSprite constructor method to draw the shape
- and add mouse events for the shape (as explained in the following steps). The <codeph class="+ topic/ph pr-d/codeph ">child</codeph>
- object is added to the top of the display list at coordinates <i class="+ topic/ph hi-d/i ">x = 0, y = 0</i>. </li><li class="- topic/li ">In the <codeph class="+ topic/ph pr-d/codeph ">ChildSprite</codeph> class, declare the <codeph class="+ topic/ph pr-d/codeph ">size</codeph> and
- <codeph class="+ topic/ph pr-d/codeph ">overSize</codeph> properties that are used later in the <codeph class="+ topic/ph pr-d/codeph ">draw()</codeph> method and
- MouseEvent methods.</li><li class="- topic/li ">Declare properties that set the background color to orange, the mouse-over color to
- dark yellow, and the mouse-down color to light blue.</li><li class="- topic/li ">In the <codeph class="+ topic/ph pr-d/codeph ">ChildSprite</codeph> constructor, an orange square is drawn by using methods from
- the Graphics class and the <codeph class="+ topic/ph pr-d/codeph ">draw()</codeph> method.</li><li class="- topic/li ">The constructor adds four MouseEvent event listener methods:
-
- <ul class="- topic/ul "><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">mouseOverHandler</codeph>: redraws a larger 60 x 60 pixel square with a dark-yellow color
- at the original coordinates.</li><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">mouseOutHandler</codeph>: returns the square to its original size and color.</li><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">mouseDownHandler</codeph>: redraws a larger 60 x 60 pixel square with a light-blue color
- at the original coordinates.</li><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">mouseUpHandler</codeph>: same as <codeph class="+ topic/ph pr-d/codeph ">mouseOverHandler</codeph>.</li></ul>
- </li></ol>
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- package {
- import flash.display.Sprite;
- public class InteractiveObjectExample extends Sprite {
- public function InteractiveObjectExample() {
- var child:Sprite = new ChildSprite();
- addChild(child);
- }
- }
- }
- import flash.display.Sprite;
- import flash.events.MouseEvent;
- class ChildSprite extends Sprite {
- private var size:uint = 50;
- private var overSize:uint = 60;
- private var backgroundColor:uint = 0xFFCC00;
- private var overColor:uint = 0xCCFF00;
- private var downColor:uint = 0x00CCFF;
- public function ChildSprite() {
- buttonMode = true;
- draw(size, size, backgroundColor);
- addEventListener(MouseEvent.MOUSE_OVER, mouseOverHandler);
- addEventListener(MouseEvent.MOUSE_OUT, mouseOutHandler);
- addEventListener(MouseEvent.MOUSE_DOWN, mouseDownHandler);
- addEventListener(MouseEvent.MOUSE_UP, mouseUpHandler);
- }
- private function draw(w:uint, h:uint, bgColor:uint):void {
- graphics.clear();
- graphics.beginFill(bgColor);
- graphics.drawRect(0, 0, w, h);
- graphics.endFill();
- }
- public function mouseOverHandler(event:MouseEvent):void {
- trace("mouseOverHandler");
- draw(overSize, overSize, overColor);
- }
- public function mouseOutHandler(event:MouseEvent):void {
- trace("mouseOutHandler");
- draw(size, size, backgroundColor);
- }
- public function mouseDownHandler(event:MouseEvent):void {
- trace("mouseDownHandler");
- draw(overSize, overSize, downColor);
- }
- public function mouseUpHandler(event:MouseEvent):void {
- trace("mouseUpHandler");
- draw(overSize, overSize, overColor);
- }
- }
- </codeblock></example></apiClassifierDetail><adobeApiEvent id="flash.display:InteractiveObject_flash.events.SoftKeyboardEvent.SOFT_KEYBOARD_DEACTIVATE_softKeyboardDeactivate" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">softKeyboardDeactivate</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched immediately after the soft keyboard is lowered.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.2" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2.6" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.SoftKeyboardEvent.SOFT_KEYBOARD_DEACTIVATE</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.SoftKeyboardEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/><apiTipTexts><apiTipText class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiTipText ">Dispatched immediately after the soft keyboard is lowered.
- </apiTipText></apiTipTexts></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched immediately after the soft keyboard is lowered.
- </apiDesc></adobeApiEventDetail><related-links class="- topic/related-links "><link href="flash.events.xml#SoftKeyboardEvent" class="- topic/link "><linktext class="- topic/linktext ">flash.events.SoftKeyboardEvent</linktext></link></related-links></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.SoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATE_softKeyboardActivate" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">softKeyboardActivate</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched immediately after the soft keyboard is raised.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.2" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2.6" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.SoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATE</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.SoftKeyboardEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/><apiTipTexts><apiTipText class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiTipText ">Dispatched immediately after the soft keyboard is raised.
- </apiTipText></apiTipTexts></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched immediately after the soft keyboard is raised.
- </apiDesc></adobeApiEventDetail><related-links class="- topic/related-links "><link href="flash.events.xml#SoftKeyboardEvent" class="- topic/link "><linktext class="- topic/linktext ">flash.events.SoftKeyboardEvent</linktext></link></related-links></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.SoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATING_softKeyboardActivating" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">softKeyboardActivating</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched immediately before the soft keyboard is raised.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.2" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2.6" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.SoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATING</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.SoftKeyboardEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/><apiTipTexts><apiTipText class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiTipText ">Dispatched immediately before the soft keyboard is raised.
- </apiTipText></apiTipTexts></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched immediately before the soft keyboard is raised.
- </apiDesc></adobeApiEventDetail><related-links class="- topic/related-links "><link href="flash.events.xml#SoftKeyboardEvent" class="- topic/link "><linktext class="- topic/linktext ">flash.events.SoftKeyboardEvent</linktext></link></related-links></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.TextEvent.TEXT_INPUT_textInput" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">textInput</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when a user enters one or more
- characters of text.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.TextEvent.TEXT_INPUT</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.TextEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when a user enters one or more
- characters of text. Various
- text input methods can generate this event, including standard keyboards,
- input method editors (IMEs), voice or speech recognition systems, and even the act
- of pasting plain text with no formatting or style information.
- </apiDesc><example conref="examples\TextField_textInput.as" class="- topic/example "/></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.IMEEvent_imeStartComposition" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">imeStartComposition</apiName><shortdesc class="- topic/shortdesc ">
- This event is dispatched to any client app that supports inline input with an IME
-
- </shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.IMEEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- This event is dispatched to any client app that supports inline input with an IME
-
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.MouseEvent.CONTEXT_MENU_contextMenu" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">contextMenu</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when a user gesture triggers the context menu associated with this interactive
- object in an AIR application.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="AIR" version="1.0" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.MouseEvent.CONTEXT_MENU</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.MouseEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when a user gesture triggers the context menu associated with this interactive
- object in an AIR application.
-
- </apiDesc></adobeApiEventDetail><related-links class="- topic/related-links "><link href="flash.display.xml#InteractiveObject/contextMenu" class="- topic/link "><linktext class="- topic/linktext ">contextMenu</linktext></link></related-links></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.NativeDragEvent.NATIVE_DRAG_COMPLETE_nativeDragComplete" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">nativeDragComplete</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="AIR" version="1.0" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.NativeDragEvent.NATIVE_DRAG_COMPLETE</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.NativeDragEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.
-
- <p class="- topic/p ">The event's dropAction property indicates the action set
- by the drag target object; a value of "none" (<codeph class="+ topic/ph pr-d/codeph ">DragActions.NONE</codeph>)
- indicates that the drop was canceled or was not accepted.</p>
-
- <p class="- topic/p ">The <codeph class="+ topic/ph pr-d/codeph ">nativeDragComplete</codeph> event handler is a convenient place
- to update the state of the initiating display object, for example, by removing
- an item from a list (on a drag action of "move"), or by changing the visual
- properties.</p>
-
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.NativeDragEvent.NATIVE_DRAG_UPDATE_nativeDragUpdate" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">nativeDragUpdate</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched during a drag operation by the InteractiveObject that is
- specified as the drag initiator in the DragManager.doDrag() call.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="AIR" version="1.0" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.NativeDragEvent.NATIVE_DRAG_UPDATE</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.NativeDragEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched during a drag operation by the InteractiveObject that is
- specified as the drag initiator in the DragManager.doDrag() call.
-
- <p class="- topic/p "><codeph class="+ topic/ph pr-d/codeph ">nativeDragUpdate</codeph> events are not dispatched on Linux.</p>
-
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.NativeDragEvent.NATIVE_DRAG_START_nativeDragStart" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">nativeDragStart</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched at the beginning of a drag operation by the InteractiveObject that is
- specified as the drag initiator in the DragManager.doDrag() call.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="AIR" version="1.0" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.NativeDragEvent.NATIVE_DRAG_START</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.NativeDragEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched at the beginning of a drag operation by the InteractiveObject that is
- specified as the drag initiator in the DragManager.doDrag() call.
-
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.NativeDragEvent.NATIVE_DRAG_EXIT_nativeDragExit" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">nativeDragExit</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched by an InteractiveObject when a drag gesture leaves its boundary.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="AIR" version="1.0" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.NativeDragEvent.NATIVE_DRAG_EXIT</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.NativeDragEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched by an InteractiveObject when a drag gesture leaves its boundary.
-
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.NativeDragEvent.NATIVE_DRAG_DROP_nativeDragDrop" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">nativeDragDrop</apiName><shortdesc class="- topic/shortdesc ">
- 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().</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="AIR" version="1.0" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.NativeDragEvent.NATIVE_DRAG_DROP</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.NativeDragEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- 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().
-
- <p class="- topic/p ">Access the dropped data using the event object <codeph class="+ topic/ph pr-d/codeph ">clipboard</codeph>
- property.</p>
-
- <p class="- topic/p ">The handler for this event should set the <codeph class="+ topic/ph pr-d/codeph ">DragManager.dropAction</codeph>
- property to provide feedback to the initiator object about which drag action
- was taken. If no value is set, the DragManager will select a default value
- from the list of allowed actions.</p>
-
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.NativeDragEvent.NATIVE_DRAG_OVER_nativeDragOver" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">nativeDragOver</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched by an InteractiveObject continually while a drag gesture remains within its
- boundary.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="AIR" version="1.0" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.NativeDragEvent.NATIVE_DRAG_OVER</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.NativeDragEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched by an InteractiveObject continually while a drag gesture remains within its
- boundary.
-
- <p class="- topic/p "><codeph class="+ topic/ph pr-d/codeph ">nativeDragOver</codeph> events are dispatched whenever the mouse is moved. On Windows and
- Mac, they are also dispatched on a short timer interval even when the mouse has not moved.</p>
-
- <p class="- topic/p ">Handle either the <codeph class="+ topic/ph pr-d/codeph ">nativeDragOver</codeph> or <codeph class="+ topic/ph pr-d/codeph ">nativeDragEnter</codeph>
- events to allow the display object to become the drop target.</p>
-
- <p class="- topic/p ">To determine whether the dispatching display object can accept the drop,
- check the suitability of the data in <codeph class="+ topic/ph pr-d/codeph ">clipboard</codeph> property of
- the event object, and the allowed drag actions in the <codeph class="+ topic/ph pr-d/codeph ">allowedActions</codeph>
- property.</p>
-
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.NativeDragEvent.NATIVE_DRAG_ENTER_nativeDragEnter" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">nativeDragEnter</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched by an InteractiveObject when a drag gesture enters its boundary.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="AIR" version="1.0" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.NativeDragEvent.NATIVE_DRAG_ENTER</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.NativeDragEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched by an InteractiveObject when a drag gesture enters its boundary.
-
- <p class="- topic/p ">Handle either the <codeph class="+ topic/ph pr-d/codeph ">nativeDragEnter</codeph> or <codeph class="+ topic/ph pr-d/codeph ">nativeDragOver</codeph>
- events to allow the display object to become the drop target.</p>
-
- <p class="- topic/p ">To determine whether the dispatching display object can accept the drop,
- check the suitability of the data in <codeph class="+ topic/ph pr-d/codeph ">clipboard</codeph> property of
- the event object, and the allowed drag actions in the <codeph class="+ topic/ph pr-d/codeph ">allowedActions</codeph>
- property.</p>
-
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.Event.TAB_INDEX_CHANGE_tabIndexChange" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">tabIndexChange</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when the value of the object's tabIndex property changes.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.Event.TAB_INDEX_CHANGE</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.Event</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when the value of the object's <codeph class="+ topic/ph pr-d/codeph ">tabIndex</codeph> property changes.
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.Event.TAB_ENABLED_CHANGE_tabEnabledChange" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">tabEnabledChange</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when the object's tabEnabled flag changes.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.Event.TAB_ENABLED_CHANGE</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.Event</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when the object's <codeph class="+ topic/ph pr-d/codeph ">tabEnabled</codeph> flag changes.
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.Event.TAB_CHILDREN_CHANGE_tabChildrenChange" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">tabChildrenChange</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when the value of the object's tabChildren flag changes.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.Event.TAB_CHILDREN_CHANGE</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.Event</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when the value of the object's <codeph class="+ topic/ph pr-d/codeph ">tabChildren</codeph> flag changes.
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.KeyboardEvent.KEY_UP_keyUp" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">keyUp</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when the user releases a key.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.KeyboardEvent.KEY_UP</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.KeyboardEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when the user releases a key. Mappings between keys and specific characters vary
- by device and operating system. This event type is generated after such a mapping occurs
- but before the processing of an input method editor (IME). IMEs are used to enter
- characters, such as Chinese ideographs, that the standard QWERTY keyboard is
- ill-equipped to produce. This event occurs after a <codeph class="+ topic/ph pr-d/codeph ">keyDown</codeph> event and has
- the following characteristics:
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.KeyboardEvent.KEY_DOWN_keyDown" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">keyDown</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when the user presses a key.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.KeyboardEvent.KEY_DOWN</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.KeyboardEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when the user presses a key. Mappings between keys and specific characters
- vary by device and operating system. This event type is generated after such a mapping
- occurs but before the processing of an input method
- editor (IME). IMEs are used to enter characters, such as Chinese ideographs, that the standard QWERTY keyboard is ill-equipped
- to produce. This event occurs before the <codeph class="+ topic/ph pr-d/codeph ">keyUp</codeph> event.
-
- <p class="- topic/p ">In AIR, canceling this event prevents the character from being entered into a text field.</p>
-
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.MouseEvent.RIGHT_MOUSE_UP_rightMouseUp" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">rightMouseUp</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when a user releases the pointing device button over an
- InteractiveObject instance.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="AIR" version="1.0" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.MouseEvent.RIGHT_MOUSE_UP</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.MouseEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when a user releases the pointing device button over an
- InteractiveObject instance.
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.MouseEvent.RIGHT_MOUSE_DOWN_rightMouseDown" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">rightMouseDown</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when a user presses the pointing device button over an InteractiveObject instance.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="AIR" version="1.0" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.MouseEvent.RIGHT_MOUSE_DOWN</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.MouseEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when a user presses the pointing device button over an InteractiveObject instance.
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.MouseEvent.RIGHT_CLICK_rightClick" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">rightClick</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when a user presses and releases the right button of the user's
- pointing device over the same InteractiveObject.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="AIR" version="1.0" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.MouseEvent.RIGHT_CLICK</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.MouseEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when a user presses and releases the right button of the user's
- pointing device over the same InteractiveObject. For a <codeph class="+ topic/ph pr-d/codeph ">rightClick</codeph> event to occur, it must always follow this series of
- events in the order of occurrence: <codeph class="+ topic/ph pr-d/codeph ">rightMouseDown</codeph> event, then <codeph class="+ topic/ph pr-d/codeph ">rightMouseUp</codeph>. The target object
- must be identical for both of these events; otherwise the <codeph class="+ topic/ph pr-d/codeph ">rightClick</codeph> event does not
- occur. Any number of other mouse events can occur at any time between the
- <codeph class="+ topic/ph pr-d/codeph ">rightMouseDown</codeph> or <codeph class="+ topic/ph pr-d/codeph ">rightMouseUp</codeph> events; the <codeph class="+ topic/ph pr-d/codeph ">rightClick</codeph> event
- still occurs.
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.MouseEvent.MIDDLE_MOUSE_UP_middleMouseUp" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">middleMouseUp</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when a user releases the pointing device button over an
- InteractiveObject instance.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="AIR" version="1.0" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.MouseEvent.MIDDLE_MOUSE_UP</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.MouseEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when a user releases the pointing device button over an
- InteractiveObject instance.
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.MouseEvent.MIDDLE_MOUSE_DOWN_middleMouseDown" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">middleMouseDown</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="AIR" version="1.0" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.MouseEvent.MIDDLE_MOUSE_DOWN</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.MouseEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.MouseEvent.MIDDLE_CLICK_middleClick" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">middleClick</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when a user presses and releases the middle button of the user's
- pointing device over the same InteractiveObject.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="AIR" version="1.0" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.MouseEvent.MIDDLE_CLICK</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.MouseEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when a user presses and releases the middle button of the user's
- pointing device over the same InteractiveObject. For a <codeph class="+ topic/ph pr-d/codeph ">middleClick</codeph> event to occur, it must always follow this series of
- events in the order of occurrence: <codeph class="+ topic/ph pr-d/codeph ">middleMouseDown</codeph> event, then <codeph class="+ topic/ph pr-d/codeph ">middleMouseUp</codeph>. The target object
- must be identical for both of these events; otherwise the <codeph class="+ topic/ph pr-d/codeph ">middleClick</codeph> event does not
- occur. Any number of other mouse events can occur at any time between the
- <codeph class="+ topic/ph pr-d/codeph ">middleMouseDown</codeph> or <codeph class="+ topic/ph pr-d/codeph ">middleMouseUp</codeph> events; the <codeph class="+ topic/ph pr-d/codeph ">middleClick</codeph> event
- still occurs.
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.TransformGestureEvent.GESTURE_SWIPE_gestureSwipe" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">gestureSwipe</apiName><shortdesc class="- topic/shortdesc ">
- 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).</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.1" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.TransformGestureEvent.GESTURE_SWIPE</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.TransformGestureEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- 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).
- Moving several fingers in parallel is a common swipe gesture,
- but each device and operating system can have its own requirements for a swipe.
- Some devices might also interpret this contact as a combination of several mouse events, as well.
- <p class="- topic/p ">Specifically, if a user moves a finger over an InteractiveObject, and then moves the fingers together, the InteractiveObject instance can
- dispatch a <codeph class="+ topic/ph pr-d/codeph ">rollOver</codeph>
- event and a <codeph class="+ topic/ph pr-d/codeph ">rollOut</codeph> event (among others), in addition to the <codeph class="+ topic/ph pr-d/codeph ">gestureSwipe</codeph> event, or all if the current environment supports it.
- Choose how you want to handle the user interaction.
- If you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">rollOver</codeph> event, then the same event handler will run on a touch-enabled device and
- a mouse enabled device. However, if you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">gestureSwipe</codeph> event, you can design your event handler
- to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled
- experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.</p>
- <p class="- topic/p ">When handling the properties of the event object, note that the <codeph class="+ topic/ph pr-d/codeph ">localX</codeph> and <codeph class="+ topic/ph pr-d/codeph ">localY</codeph> properties are set to the
- primary point of contact. The <codeph class="+ topic/ph pr-d/codeph ">offsetX</codeph> and <codeph class="+ topic/ph pr-d/codeph ">offsetY</codeph> properties are the distance to the point of contact where the swipe gesture
- is complete.</p>
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> While some devices using the Mac OS operating system can
- interpret a four-finger swipe, this API only supports a three-finger swipe.</p>
- </apiDesc><example conref="..\events\examples\TransformGesture_swipe.as" class="- topic/example "> The following example shows event handling for the <codeph class="+ topic/ph pr-d/codeph ">GESTURE_SWIPE</codeph> events.
- While the user performs a swipe gesture on the touch-enabled device, myTextField populates with the phase <codeph class="+ topic/ph pr-d/codeph ">all</codeph>,
- which is the only phase for swipe events.
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- Multitouch.inputMode = MultitouchInputMode.GESTURE;
- var mySprite = new Sprite();
- mySprite.addEventListener(TransformGestureEvent.GESTURE_SWIPE , onSwipe);
- mySprite.graphics.beginFill(0x336699);
- mySprite.graphics.drawRect(0, 0, 100, 80);
- var myTextField = new TextField();
- myTextField.y = 200;
- addChild(mySprite);
- addChild(myTextField);
- function onSwipe(evt:TransformGestureEvent):void {
- if (evt.offsetX == 1 ) {
- myTextField.text = "right";
- }
- if (evt.offsetY == -1) {
- myTextField.text = "up";
- }
- myTextField.text = evt.phase;
- }
- </codeblock></example></adobeApiEventDetail><related-links class="- topic/related-links "><link href="flash.display.xml#InteractiveObject/event:rollOver" class="- topic/link "><linktext class="- topic/linktext ">rollOver event</linktext></link><link href="flash.display.xml#InteractiveObject/event:touchOver" class="- topic/link "><linktext class="- topic/linktext ">touchOver event</linktext></link><link href="flash.ui.xml#Multitouch" class="- topic/link "><linktext class="- topic/linktext ">flash.ui.Multitouch</linktext></link></related-links></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.TransformGestureEvent.GESTURE_ZOOM_gestureZoom" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">gestureZoom</apiName><shortdesc class="- topic/shortdesc ">
- 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).</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.1" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.TransformGestureEvent.GESTURE_ZOOM</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.TransformGestureEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- 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).
- Moving fingers apart is a common zoom gesture,
- but each device and operating system can have its own requirements to indicate zoom.
- Some devices might also interpret this contact as a combination of several mouse events, as well.
- <p class="- topic/p ">Specifically, if a user moves a finger over an InteractiveObject, and then moves the fingers apart, the InteractiveObject instance can
- dispatch a <codeph class="+ topic/ph pr-d/codeph ">mouseOver</codeph>
- event and a <codeph class="+ topic/ph pr-d/codeph ">click</codeph> event (among others), in addition to the <codeph class="+ topic/ph pr-d/codeph ">gestureZoom</codeph> event, or all if the current environment supports it.
- Choose how you want to handle the user interaction. Use the flash.ui.Multitouch class to manage touch event handling (enable touch gesture event handling,
- simple touch point event handling, or disable touch events so only mouse events are dispatched).
- If you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">mouseOver</codeph> event, then the same event handler will run on a touch-enabled device and
- a mouse enabled device. However, if you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">gestureZoom</codeph> event, you can design your event handler
- to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled
- experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.</p>
- <p class="- topic/p ">When handling the properties of the event object, note that the <codeph class="+ topic/ph pr-d/codeph ">localX</codeph> and <codeph class="+ topic/ph pr-d/codeph ">localY</codeph> properties are set to the
- primary point of contact. The <codeph class="+ topic/ph pr-d/codeph ">offsetX</codeph> and <codeph class="+ topic/ph pr-d/codeph ">offsetY</codeph> properties are the distance to the point of contact where the zoom gesture
- is complete.</p>
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> See the Multitouch class for environment compatibility information.</p>
- </apiDesc><example conref="..\events\examples\TransformGesture_zoom.as" class="- topic/example "> The following example shows event handling for the <codeph class="+ topic/ph pr-d/codeph ">GESTURE_ZOOM</codeph> events.
- While the user performs a zoom gesture on the touch-enabled device, myTextField populates with the current phase.
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- Multitouch.inputMode = MultitouchInputMode.GESTURE;
- var mySprite = new Sprite();
- mySprite.addEventListener(TransformGestureEvent.GESTURE_ZOOM , onZoom);
- mySprite.graphics.beginFill(0x336699);
- mySprite.graphics.drawRect(0, 0, 100, 80);
- var myTextField = new TextField();
- myTextField.y = 200;
- addChild(mySprite);
- addChild(myTextField);
- function onZoom(evt:TransformGestureEvent):void {
- evt.target.scaleX++;
- if (evt.phase==GesturePhase.BEGIN) {
- myTextField.text = "Begin";
- }
- if (evt.phase==GesturePhase.UPDATE) {
- myTextField.text = "Update";
- }
- if (evt.phase==GesturePhase.END) {
- myTextField.text = "End";
- }
- }
- </codeblock></example></adobeApiEventDetail><related-links class="- topic/related-links "><link href="flash.display.xml#InteractiveObject/event:mouseOver" class="- topic/link "><linktext class="- topic/linktext ">mouseOver event</linktext></link><link href="flash.display.xml#InteractiveObject/event:touchOver" class="- topic/link "><linktext class="- topic/linktext ">touchOver event</linktext></link><link href="flash.ui.xml#Multitouch" class="- topic/link "><linktext class="- topic/linktext ">flash.ui.Multitouch</linktext></link></related-links></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.TransformGestureEvent.GESTURE_ROTATE_gestureRotate" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">gestureRotate</apiName><shortdesc class="- topic/shortdesc ">
- 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).</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.1" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.TransformGestureEvent.GESTURE_ROTATE</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.TransformGestureEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- 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). Two-finger rotation is a common rotation gesture,
- but each device and operating system can have its own requirements to indicate rotation.
- Some devices might also interpret this contact as a combination of several mouse events, as well.
- <p class="- topic/p ">Specifically, if a user moves a finger over an InteractiveObject, the InteractiveObject instance can
- dispatch a <codeph class="+ topic/ph pr-d/codeph ">mouseOver</codeph>
- event and a <codeph class="+ topic/ph pr-d/codeph ">click</codeph> event (among others), in addition to the <codeph class="+ topic/ph pr-d/codeph ">gestureRotate</codeph> event, or all if the current environment supports it.
- Choose how you want to handle the user interaction. Use the flash.ui.Multitouch class to manage touch event handling (enable touch gesture event handling,
- simple touch point event handling, or disable touch events so only mouse events are dispatched).
- If you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">mouseOver</codeph> event, then the same event handler will run on a touch-enabled device and
- a mouse enabled device. However, if you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">gestureRotate</codeph> event, you can design your event handler
- to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled
- experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.</p>
- <p class="- topic/p ">When handling the properties of the event object, note that the <codeph class="+ topic/ph pr-d/codeph ">localX</codeph> and <codeph class="+ topic/ph pr-d/codeph ">localY</codeph> properties are set to the
- primary point of contact. The <codeph class="+ topic/ph pr-d/codeph ">offsetX</codeph> and <codeph class="+ topic/ph pr-d/codeph ">offsetY</codeph> properties are the distance to the point of contact where the rotation gesture
- is complete.</p>
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> See the Multitouch class for environment compatibility information.</p>
- </apiDesc><example conref="..\events\examples\TransformGestureEventExample.as" class="- topic/example "> The following example shows event handling for the <codeph class="+ topic/ph pr-d/codeph ">GESTURE_ROTATE</codeph> events.
- While the user performs a rotation gesture on the touch-enabled device, mySprite rotates and myTextField populates with the current phase.
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- Multitouch.inputMode = MultitouchInputMode.GESTURE;
- var mySprite = new Sprite();
- mySprite.addEventListener(TransformGestureEvent.GESTURE_ROTATE , onRotate );
- mySprite.graphics.beginFill(0x336699);
- mySprite.graphics.drawRect(0, 0, 100, 80);
- var myTextField = new TextField();
- myTextField.y = 200;
- addChild(mySprite);
- addChild(myTextField);
- function onRotate(evt:TransformGestureEvent):void {
- evt.target.rotation -= 45;
- if (evt.phase==GesturePhase.BEGIN) {
- myTextField.text = "Begin";
- }
- if (evt.phase==GesturePhase.UPDATE) {
- myTextField.text = "Update";
- }
- if (evt.phase==GesturePhase.END) {
- myTextField.text = "End";
- }
- }
- </codeblock></example></adobeApiEventDetail><related-links class="- topic/related-links "><link href="flash.display.xml#InteractiveObject/event:mouseOver" class="- topic/link "><linktext class="- topic/linktext ">mouseOver event</linktext></link><link href="flash.display.xml#InteractiveObject/event:touchOver" class="- topic/link "><linktext class="- topic/linktext ">touchOver event</linktext></link><link href="flash.ui.xml#Multitouch" class="- topic/link "><linktext class="- topic/linktext ">flash.ui.Multitouch</linktext></link></related-links></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.PressAndTapGestureEvent.GESTURE_PRESS_AND_TAP_gesturePressAndTap" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">gesturePressAndTap</apiName><shortdesc class="- topic/shortdesc ">
- 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).</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.1" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.PressAndTapGestureEvent.GESTURE_PRESS_AND_TAP</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.PressAndTapGestureEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- 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).
- Some devices might also interpret this contact as a combination of several mouse events, as well.
- <p class="- topic/p ">Specifically, if a user moves a finger over an InteractiveObject, and then provides a secondary tap, the InteractiveObject instance can
- dispatch a <codeph class="+ topic/ph pr-d/codeph ">mouseOver</codeph>
- event and a <codeph class="+ topic/ph pr-d/codeph ">click</codeph> event (among others) as well as the <codeph class="+ topic/ph pr-d/codeph ">gesturePressAndTap</codeph> event, or all if the current environment supports it.
- Choose how you want to handle the user interaction. Use the flash.ui.Multitouch class to manage touch event handling (enable touch gesture event handling,
- simple touch point event handling, or disable touch events so only mouse events are dispatched).
- If you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">mouseOver</codeph> event, then the same event handler will run on a touch-enabled device and
- a mouse enabled device. However, if you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">gesturePressAndTap</codeph> event, you can design your event handler
- to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled
- experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.</p>
- <p class="- topic/p ">When handling the properties of the event object, note that the <codeph class="+ topic/ph pr-d/codeph ">localX</codeph> and <codeph class="+ topic/ph pr-d/codeph ">localY</codeph> properties are set to the
- primary point of contact (the "push"). The <codeph class="+ topic/ph pr-d/codeph ">offsetX</codeph> and <codeph class="+ topic/ph pr-d/codeph ">offsetY</codeph> properties are the distance to the secondary point of
- contact (the "tap").</p>
- </apiDesc></adobeApiEventDetail><related-links class="- topic/related-links "><link href="flash.display.xml#InteractiveObject/event:mouseOver" class="- topic/link "><linktext class="- topic/linktext ">mouseOver event</linktext></link><link href="flash.display.xml#InteractiveObject/event:touchOver" class="- topic/link "><linktext class="- topic/linktext ">touchOver event</linktext></link><link href="flash.ui.xml#Multitouch" class="- topic/link "><linktext class="- topic/linktext ">flash.ui.Multitouch</linktext></link></related-links></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.TransformGestureEvent.GESTURE_PAN_gesturePan" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">gesturePan</apiName><shortdesc class="- topic/shortdesc ">
- 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).</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.1" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.TransformGestureEvent.GESTURE_PAN</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.TransformGestureEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- 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).
- Some devices might also interpret this contact as a <codeph class="+ topic/ph pr-d/codeph ">mouseOver</codeph> event and as a <codeph class="+ topic/ph pr-d/codeph ">touchOver</codeph> event.
- <p class="- topic/p ">Specifically, if a user moves a finger over an InteractiveObject, the InteractiveObject instance can dispatch a <codeph class="+ topic/ph pr-d/codeph ">mouseOver</codeph>
- event or a <codeph class="+ topic/ph pr-d/codeph ">touchOver</codeph> event or a <codeph class="+ topic/ph pr-d/codeph ">gesturePan</codeph> event, or all if the current environment supports it.
- Choose how you want to handle the user interaction. Use the flash.ui.Multitouch class to manage touch event handling (enable touch gesture event handling,
- simple touch point event handling, or disable touch events so only mouse events are dispatched).
- If you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">mouseOver</codeph> event, then the same event handler will run on a touch-enabled device and
- a mouse enabled device. However, if you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">gesturePan</codeph> event, you can design your event handler
- to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled
- experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.</p>
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> See the Multitouch class for environment compatibility information.</p>
- </apiDesc><example conref="..\events\examples\TransformGesture_pan.as" class="- topic/example "> The following example shows event handling for the <codeph class="+ topic/ph pr-d/codeph ">GESTURE_PAN</codeph> events.
- While the user performs a pan gesture on the touch-enabled device, myTextField populates with the current phase.
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- Multitouch.inputMode = MultitouchInputMode.GESTURE;
- var mySprite = new Sprite();
- mySprite.addEventListener(TransformGestureEvent.GESTURE_PAN , onPan);
- mySprite.graphics.beginFill(0x336699);
- mySprite.graphics.drawRect(0, 0, 100, 80);
- var myTextField = new TextField();
- myTextField.y = 200;
- addChild(mySprite);
- addChild(myTextField);
- function onPan(evt:TransformGestureEvent):void {
- evt.target.localX++;
- if (evt.phase==GesturePhase.BEGIN) {
- myTextField.text = "Begin";
- }
- if (evt.phase==GesturePhase.UPDATE) {
- myTextField.text = "Update";
- }
- if (evt.phase==GesturePhase.END) {
- myTextField.text = "End";
- }
- }
- </codeblock></example></adobeApiEventDetail><related-links class="- topic/related-links "><link href="flash.display.xml#InteractiveObject/event:mouseOver" class="- topic/link "><linktext class="- topic/linktext ">mouseOver event</linktext></link><link href="flash.display.xml#InteractiveObject/event:touchOver" class="- topic/link "><linktext class="- topic/linktext ">touchOver event</linktext></link><link href="flash.ui.xml#Multitouch" class="- topic/link "><linktext class="- topic/linktext ">flash.ui.Multitouch</linktext></link></related-links></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.GestureEvent.GESTURE_TWO_FINGER_TAP_gestureTwoFingerTap" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">gestureTwoFingerTap</apiName><shortdesc class="- topic/shortdesc ">
- 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).</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.1" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.GestureEvent.GESTURE_TWO_FINGER_TAP</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.GestureEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- 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).
- Some devices might also interpret this contact as a <codeph class="+ topic/ph pr-d/codeph ">doubleClick</codeph> event.
- <p class="- topic/p ">Specifically, if a user taps two fingers over an InteractiveObject, the InteractiveObject instance can dispatch a <codeph class="+ topic/ph pr-d/codeph ">doubleClick</codeph>
- event or a <codeph class="+ topic/ph pr-d/codeph ">gestureTwoFingerTap</codeph> event, or both if the current environment supports it. Choose how you want to handle the user interaction.
- Use the flash.ui.Multitouch class to manage touch event handling (enable touch gesture event handling,
- simple touch point event handling, or disable touch events so only mouse events are dispatched).
- If you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">doubleClick</codeph> event, then the same event handler will run on a touch-enabled device and
- a mouse enabled device. However, if you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">gestureTwoFingerTap</codeph> event, you can design your event handler
- to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled
- experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.</p>
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> See the Multitouch class for environment compatibility information.</p>
- </apiDesc></adobeApiEventDetail><related-links class="- topic/related-links "><link href="flash.display.xml#InteractiveObject/event:doubleClick" class="- topic/link "><linktext class="- topic/linktext ">doubleClick event</linktext></link><link href="flash.ui.xml#Multitouch" class="- topic/link "><linktext class="- topic/linktext ">flash.ui.Multitouch</linktext></link></related-links></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.TouchEvent.TOUCH_TAP_touchTap" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">touchTap</apiName><shortdesc class="- topic/shortdesc ">
- 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).</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.1" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.TouchEvent.TOUCH_TAP</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.TouchEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- 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).
- Some devices might also interpret this contact as a <codeph class="+ topic/ph pr-d/codeph ">click</codeph> event.
- <p class="- topic/p ">Specifically, if a user taps a finger over an InteractiveObject, the InteractiveObject instance can dispatch a <codeph class="+ topic/ph pr-d/codeph ">click</codeph>
- event or a <codeph class="+ topic/ph pr-d/codeph ">touchTap</codeph> event, or both if the current environment supports it. Choose how you want to handle the user interaction.
- Use the flash.ui.Multitouch class to manage touch event handling (enable touch gesture event handling,
- simple touch point event handling, or disable touch events so only mouse events are dispatched).
- If you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">click</codeph> event, then the same event handler will run on a touch-enabled device and
- a mouse enabled device. However, if you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">touchTap</codeph> event, you can design your event handler
- to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled
- experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.</p>
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> See the Multitouch class for environment compatibility information.</p>
- </apiDesc><example conref="..\ui\examples\Multitouch_inputMode.as" class="- topic/example "> The following example displays a message when the
- square drawn on mySprite is tapped on a touch-enabled screen:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- Multitouch.inputMode=MultitouchInputMode.TOUCH_POINT;
- var mySprite:Sprite = new Sprite();
- var myTextField:TextField = new TextField();
- mySprite.graphics.beginFill(0x336699);
- mySprite.graphics.drawRect(0,0,40,40);
- addChild(mySprite);
- mySprite.addEventListener(TouchEvent.TOUCH_TAP, taphandler);
- function taphandler(e:TouchEvent): void {
- myTextField.text = "I've been tapped";
- myTextField.y = 50;
- addChild(myTextField);
- }
- </codeblock></example></adobeApiEventDetail><related-links class="- topic/related-links "><link href="flash.display.xml#InteractiveObject/event:click" class="- topic/link "><linktext class="- topic/linktext ">click event</linktext></link><link href="flash.ui.xml#Multitouch" class="- topic/link "><linktext class="- topic/linktext ">flash.ui.Multitouch</linktext></link></related-links></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.TouchEvent.TOUCH_ROLL_OVER_touchRollOver" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">touchRollOver</apiName><shortdesc class="- topic/shortdesc ">
- 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).</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.1" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.TouchEvent.TOUCH_ROLL_OVER</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.TouchEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- 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).
- Some devices might also interpret this contact as a <codeph class="+ topic/ph pr-d/codeph ">rollOver</codeph> event.
- <p class="- topic/p ">Specifically, if a user moves a finger over an InteractiveObject, the InteractiveObject instance can dispatch a <codeph class="+ topic/ph pr-d/codeph ">rollOver</codeph>
- event or a <codeph class="+ topic/ph pr-d/codeph ">touchRollOver</codeph> event, or both if the current environment supports it. Choose how you want to handle the user interaction.
- Use the flash.ui.Multitouch class to manage touch event handling (enable touch gesture event handling,
- simple touch point event handling, or disable touch events so only mouse events are dispatched).
- If you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">rollOver</codeph> event, then the same event handler will run on a touch-enabled device and
- a mouse enabled device. However, if you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">touchRollOver</codeph> event, you can design your event handler
- to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled
- experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.</p>
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> See the Multitouch class for environment compatibility information.</p>
- </apiDesc></adobeApiEventDetail><related-links class="- topic/related-links "><link href="flash.display.xml#InteractiveObject/event:rollOver" class="- topic/link "><linktext class="- topic/linktext ">rollOver event</linktext></link><link href="flash.ui.xml#Multitouch" class="- topic/link "><linktext class="- topic/linktext ">flash.ui.Multitouch</linktext></link></related-links></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.TouchEvent.TOUCH_ROLL_OUT_touchRollOut" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">touchRollOut</apiName><shortdesc class="- topic/shortdesc ">
- 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).</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.1" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.TouchEvent.TOUCH_ROLL_OUT</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.TouchEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- 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).
- Some devices might also interpret this contact as a <codeph class="+ topic/ph pr-d/codeph ">rollOut</codeph> event.
- <p class="- topic/p ">Specifically, if a user moves a finger over an InteractiveObject, the InteractiveObject instance can dispatch a <codeph class="+ topic/ph pr-d/codeph ">rollOut</codeph>
- event or a <codeph class="+ topic/ph pr-d/codeph ">touchRollOut</codeph> event, or both if the current environment supports it. Choose how you want to handle the user interaction.
- Use the flash.ui.Multitouch class to manage touch event handling (enable touch gesture event handling,
- simple touch point event handling, or disable touch events so only mouse events are dispatched).
- If you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">rollOut</codeph> event, then the same event handler will run on a touch-enabled device and
- a mouse enabled device. However, if you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">touchRollOut</codeph> event, you can design your event handler
- to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled
- experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.</p>
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> See the Multitouch class for environment compatibility information.</p>
- </apiDesc></adobeApiEventDetail><related-links class="- topic/related-links "><link href="flash.display.xml#InteractiveObject/event:rollOut" class="- topic/link "><linktext class="- topic/linktext ">rollOut event</linktext></link><link href="flash.ui.xml#Multitouch" class="- topic/link "><linktext class="- topic/linktext ">flash.ui.Multitouch</linktext></link></related-links></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.TouchEvent.TOUCH_OVER_touchOver" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">touchOver</apiName><shortdesc class="- topic/shortdesc ">
- 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).</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.1" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.TouchEvent.TOUCH_OVER</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.TouchEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- 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).
- Some devices might also interpret this contact as a <codeph class="+ topic/ph pr-d/codeph ">mouseOver</codeph> event.
- <p class="- topic/p ">Specifically, if a user moves a finger over an InteractiveObject, the InteractiveObject instance can dispatch a <codeph class="+ topic/ph pr-d/codeph ">mouseOver</codeph>
- event or a <codeph class="+ topic/ph pr-d/codeph ">touchOver</codeph> event, or both if the current environment supports it. Choose how you want to handle the user interaction.
- Use the flash.ui.Multitouch class to manage touch event handling (enable touch gesture event handling,
- simple touch point event handling, or disable touch events so only mouse events are dispatched).
- If you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">mouseOver</codeph> event, then the same event handler will run on a touch-enabled device and
- a mouse enabled device. However, if you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">touchOver</codeph> event, you can design your event handler
- to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled
- experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.</p>
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> See the Multitouch class for environment compatibility information.</p>
- </apiDesc></adobeApiEventDetail><related-links class="- topic/related-links "><link href="flash.display.xml#InteractiveObject/event:mouseOver" class="- topic/link "><linktext class="- topic/linktext ">mouseOver event</linktext></link><link href="flash.ui.xml#Multitouch" class="- topic/link "><linktext class="- topic/linktext ">flash.ui.Multitouch</linktext></link></related-links></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.TouchEvent.TOUCH_OUT_touchOut" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">touchOut</apiName><shortdesc class="- topic/shortdesc ">
- 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).</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.1" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.TouchEvent.TOUCH_OUT</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.TouchEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- 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).
- Some devices might also interpret this contact as a <codeph class="+ topic/ph pr-d/codeph ">mouseOut</codeph> event.
- <p class="- topic/p ">Specifically, if a user moves a finger across a touch screen, the InteractiveObject instance can dispatch a <codeph class="+ topic/ph pr-d/codeph ">mouseOut</codeph>
- event or a <codeph class="+ topic/ph pr-d/codeph ">touchOut</codeph> event, or both if the current environment supports it. Choose how you want to handle the user interaction.
- Use the flash.ui.Multitouch class to manage touch event handling (enable touch gesture event handling,
- simple touch point event handling, or disable touch events so only mouse events are dispatched).
- If you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">mouseOut</codeph> event, then the same event handler will run on a touch-enabled device and
- a mouse enabled device. However, if you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">touchOut</codeph> event, you can design your event handler
- to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled
- experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.</p>
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> See the Multitouch class for environment compatibility information.</p>
- </apiDesc></adobeApiEventDetail><related-links class="- topic/related-links "><link href="flash.display.xml#InteractiveObject/event:mouseOut" class="- topic/link "><linktext class="- topic/linktext ">mouseOut event</linktext></link><link href="flash.ui.xml#Multitouch" class="- topic/link "><linktext class="- topic/linktext ">flash.ui.Multitouch</linktext></link></related-links></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.TouchEvent.TOUCH_MOVE_touchMove" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">touchMove</apiName><shortdesc class="- topic/shortdesc ">
- 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).</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.1" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.TouchEvent.TOUCH_MOVE</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.TouchEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- 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).
- Some devices might also interpret this contact as a <codeph class="+ topic/ph pr-d/codeph ">mouseMove</codeph> event.
- <p class="- topic/p ">Specifically, if a user moves a finger across a touch screen, the InteractiveObject instance can dispatch a <codeph class="+ topic/ph pr-d/codeph ">mouseMove</codeph>
- event or a <codeph class="+ topic/ph pr-d/codeph ">touchMove</codeph> event, or both if the current environment supports it. Choose how you want to handle the user interaction.
- Use the flash.ui.Multitouch class to manage touch event handling (enable touch gesture event handling,
- simple touch point event handling, or disable touch events so only mouse events are dispatched).
- If you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">mouseMove</codeph> event, then the same event handler will run on a touch-enabled device and
- a mouse enabled device. However, if you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">touchMove</codeph> event, you can design your event handler
- to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled
- experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.</p>
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> See the Multitouch class for environment compatibility information.</p>
- </apiDesc><example conref="..\events\examples\TouchEventExample.as" class="- topic/example "> The following example shows event handling for the <codeph class="+ topic/ph pr-d/codeph ">TOUCH_BEGIN</codeph>, <codeph class="+ topic/ph pr-d/codeph ">TOUCH_MOVE</codeph>, and <codeph class="+ topic/ph pr-d/codeph ">TOUCH_END</codeph> events.
- While the point of contact moves across the screen (<codeph class="+ topic/ph pr-d/codeph ">onTouchMove</codeph>), the x-coordinate relative to the stage is traced to output.
- For the <codeph class="+ topic/ph pr-d/codeph ">Sprite.startTouchDrag</codeph> parameters in the <codeph class="+ topic/ph pr-d/codeph ">onTouchBegin</codeph> function, the value for touchPointID is the value assigned to the event object.
- The bounds parameter is the rectangle defining the boundaries of
- the parent display object (bg is a display object containing MySprite).
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- Multitouch.inputMode = MultitouchInputMode.TOUCH_POINT;
- MySprite.addEventListener(TouchEvent.TOUCH_BEGIN, onTouchBegin);
- MySprite.addEventListener(TouchEvent.TOUCH_MOVE, onTouchMove);
- MySprite.addEventListener(TouchEvent.TOUCH_END, onTouchEnd);
- function onTouchBegin(eBegin:TouchEvent) {
- eBegin.target.startTouchDrag(eBegin.touchPointID, false, bg.getRect(this));
- trace("touch begin");
-
- }
- function onTouchMove(eMove:TouchEvent) {
- trace(eMove.stageX);
- }
-
- function onTouchEnd(eEnd:TouchEvent) {
- eEnd.target.stopTouchDrag(eEnd.touchPointID);
- trace("touch end");
- }
- </codeblock></example></adobeApiEventDetail><related-links class="- topic/related-links "><link href="flash.display.xml#InteractiveObject/event:mouseMove" class="- topic/link "><linktext class="- topic/linktext ">mouseMove event</linktext></link><link href="flash.ui.xml#Multitouch" class="- topic/link "><linktext class="- topic/linktext ">flash.ui.Multitouch</linktext></link></related-links></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.TouchEvent.TOUCH_END_touchEnd" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">touchEnd</apiName><shortdesc class="- topic/shortdesc ">
- 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).</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.1" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.TouchEvent.TOUCH_END</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.TouchEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- 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).
- Some devices might also interpret this contact as a <codeph class="+ topic/ph pr-d/codeph ">mouseUp</codeph> event.
- <p class="- topic/p ">Specifically, if a user lifts a finger from a touch screen, the InteractiveObject instance can dispatch a <codeph class="+ topic/ph pr-d/codeph ">mouseUp</codeph>
- event or a <codeph class="+ topic/ph pr-d/codeph ">touchEnd</codeph> event, or both if the current environment supports it. Choose how you want to handle the user interaction.
- Use the flash.ui.Multitouch class to manage touch event handling (enable touch gesture event handling,
- simple touch point event handling, or disable touch events so only mouse events are dispatched).
- If you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">mouseUp</codeph> event, then the same event handler will run on a touch-enabled device and
- a mouse enabled device. However, if you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">touchEnd</codeph> event, you can design your event handler
- to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled
- experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.</p>
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> See the Multitouch class for environment compatibility information.</p>
- </apiDesc><example conref="..\events\examples\TouchEventExample.as" class="- topic/example "> The following example shows event handling for the <codeph class="+ topic/ph pr-d/codeph ">TOUCH_BEGIN</codeph>, <codeph class="+ topic/ph pr-d/codeph ">TOUCH_MOVE</codeph>, and <codeph class="+ topic/ph pr-d/codeph ">TOUCH_END</codeph> events.
- While the point of contact moves across the screen (<codeph class="+ topic/ph pr-d/codeph ">onTouchMove</codeph>), the x-coordinate relative to the stage is traced to output.
- For the <codeph class="+ topic/ph pr-d/codeph ">Sprite.startTouchDrag</codeph> parameters in the <codeph class="+ topic/ph pr-d/codeph ">onTouchBegin</codeph> function, the value for touchPointID is the value assigned to the event object.
- The bounds parameter is the rectangle defining the boundaries of
- the parent display object (bg is a display object containing MySprite).
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- Multitouch.inputMode = MultitouchInputMode.TOUCH_POINT;
- MySprite.addEventListener(TouchEvent.TOUCH_BEGIN, onTouchBegin);
- MySprite.addEventListener(TouchEvent.TOUCH_MOVE, onTouchMove);
- MySprite.addEventListener(TouchEvent.TOUCH_END, onTouchEnd);
- function onTouchBegin(eBegin:TouchEvent) {
- eBegin.target.startTouchDrag(eBegin.touchPointID, false, bg.getRect(this));
- trace("touch begin");
-
- }
- function onTouchMove(eMove:TouchEvent) {
- trace(eMove.stageX);
- }
-
- function onTouchEnd(eEnd:TouchEvent) {
- eEnd.target.stopTouchDrag(eEnd.touchPointID);
- trace("touch end");
- }
- </codeblock></example></adobeApiEventDetail><related-links class="- topic/related-links "><link href="flash.display.xml#InteractiveObject/event:mouseUp" class="- topic/link "><linktext class="- topic/linktext ">mouseUp event</linktext></link><link href="flash.ui.xml#Multitouch" class="- topic/link "><linktext class="- topic/linktext ">flash.ui.Multitouch</linktext></link></related-links></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.TouchEvent.TOUCH_BEGIN_touchBegin" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">touchBegin</apiName><shortdesc class="- topic/shortdesc ">
- 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).</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.1" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.TouchEvent.TOUCH_BEGIN</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.TouchEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- 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).
- Some devices might also interpret this contact as a <codeph class="+ topic/ph pr-d/codeph ">mouseDown</codeph> event.
- <p class="- topic/p ">Specifically, if a user touches a finger to a touch screen, the InteractiveObject instance can dispatch a <codeph class="+ topic/ph pr-d/codeph ">mouseDown</codeph>
- event or a <codeph class="+ topic/ph pr-d/codeph ">touchBegin</codeph> event, or both if the current environment supports it. Choose how you want to handle the user interaction.
- Use the flash.ui.Multitouch class to manage touch event handling (enable touch gesture event handling,
- simple touch point event handling, or disable touch events so only mouse events are dispatched).
- If you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">mouseDown</codeph> event, then the same event handler will run on a touch-enabled device and
- a mouse enabled device. However, if you choose to handle the <codeph class="+ topic/ph pr-d/codeph ">touchBegin</codeph> event, you can design your event handler
- to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled
- experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.</p>
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> See the Multitouch class for environment compatibility information.</p>
- </apiDesc><example conref="..\events\examples\TouchEventExample.as" class="- topic/example "> The following example shows event handling for the <codeph class="+ topic/ph pr-d/codeph ">TOUCH_BEGIN</codeph>, <codeph class="+ topic/ph pr-d/codeph ">TOUCH_MOVE</codeph>, and <codeph class="+ topic/ph pr-d/codeph ">TOUCH_END</codeph> events.
- While the point of contact moves across the screen (<codeph class="+ topic/ph pr-d/codeph ">onTouchMove</codeph>), the x-coordinate relative to the stage is traced to output.
- For the <codeph class="+ topic/ph pr-d/codeph ">Sprite.startTouchDrag</codeph> parameters in the <codeph class="+ topic/ph pr-d/codeph ">onTouchBegin</codeph> function, the value for touchPointID is the value assigned to the event object.
- The bounds parameter is the rectangle defining the boundaries of
- the parent display object (bg is a display object containing MySprite).
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- Multitouch.inputMode = MultitouchInputMode.TOUCH_POINT;
- MySprite.addEventListener(TouchEvent.TOUCH_BEGIN, onTouchBegin);
- MySprite.addEventListener(TouchEvent.TOUCH_MOVE, onTouchMove);
- MySprite.addEventListener(TouchEvent.TOUCH_END, onTouchEnd);
- function onTouchBegin(eBegin:TouchEvent) {
- eBegin.target.startTouchDrag(eBegin.touchPointID, false, bg.getRect(this));
- trace("touch begin");
-
- }
- function onTouchMove(eMove:TouchEvent) {
- trace(eMove.stageX);
- }
-
- function onTouchEnd(eEnd:TouchEvent) {
- eEnd.target.stopTouchDrag(eEnd.touchPointID);
- trace("touch end");
- }
- </codeblock></example></adobeApiEventDetail><related-links class="- topic/related-links "><link href="flash.display.xml#InteractiveObject/event:mouseDown" class="- topic/link "><linktext class="- topic/linktext ">mouseDown event</linktext></link><link href="flash.ui.xml#Multitouch" class="- topic/link "><linktext class="- topic/linktext ">flash.ui.Multitouch</linktext></link></related-links></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.MouseEvent.ROLL_OVER_rollOver" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">rollOver</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when the user moves a pointing device over an InteractiveObject instance.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.MouseEvent.ROLL_OVER</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.MouseEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when the user moves a pointing device over an InteractiveObject instance.
- The event target is the object under the pointing device or a parent of that object.
- The <codeph class="+ topic/ph pr-d/codeph ">relatedObject</codeph> is the object that was previously under the pointing
- device. The <codeph class="+ topic/ph pr-d/codeph ">rollOver</codeph> events are dispatched consecutively down the parent
- chain of the object, starting with the highest parent that is neither the root
- nor an ancestor of the <codeph class="+ topic/ph pr-d/codeph ">relatedObject</codeph> and ending with the object.
- <p class="- topic/p ">The purpose of the <codeph class="+ topic/ph pr-d/codeph ">rollOver</codeph> event is to simplify the coding of rollout behaviors for
- display object containers with children. When the mouse enters the area of a display
- object or the area of any of its children from an object that is not one of its
- children, the display object dispatches the <codeph class="+ topic/ph pr-d/codeph ">rollOver</codeph> event. This is different behavior
- than that of the <codeph class="+ topic/ph pr-d/codeph ">mouseOver</codeph> event, which is dispatched each time the mouse
- enters the area of any child object of the display object container, even if the mouse
- was already over another child object of the display object container. </p>
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.MouseEvent.ROLL_OUT_rollOut" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">rollOut</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when the user moves a pointing device away from an InteractiveObject
- instance.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.MouseEvent.ROLL_OUT</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.MouseEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when the user moves a pointing device away from an InteractiveObject
- instance. The event target is the object previously under the pointing device or a parent of
- that object. The <codeph class="+ topic/ph pr-d/codeph ">relatedObject</codeph> is the object that the pointing device has moved to.
- The <codeph class="+ topic/ph pr-d/codeph ">rollOut</codeph> events are dispatched consecutively up the parent chain of the object,
- starting with the object and ending with the highest parent that is neither the root nor an
- ancestor of the <codeph class="+ topic/ph pr-d/codeph ">relatedObject</codeph>.
- <p class="- topic/p ">The purpose of the <codeph class="+ topic/ph pr-d/codeph ">rollOut</codeph> event is to simplify the
- coding of rollover behaviors for display object containers with children. When the mouse leaves
- the area of a display object or the area of any of its children to go to an object that is not
- one of its children, the display object dispatches the <codeph class="+ topic/ph pr-d/codeph ">rollOut</codeph> event. This is different behavior
- than that of the <codeph class="+ topic/ph pr-d/codeph ">mouseOut</codeph> event, which is dispatched each time the mouse leaves the
- area of any child object of the display object container, even if the mouse remains over another
- child object of the display object container.</p>
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.MouseEvent.MOUSE_WHEEL_mouseWheel" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">mouseWheel</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when a mouse wheel is spun over an InteractiveObject instance.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.MouseEvent.MOUSE_WHEEL</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.MouseEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when a mouse wheel is spun over an InteractiveObject instance.
- If the target is a text field, the text scrolls as the default behavior.
- Only available on Microsoft Windows operating systems.
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.MouseEvent.MOUSE_UP_mouseUp" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">mouseUp</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when a user releases the pointing device button over an
- InteractiveObject instance.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.MouseEvent.MOUSE_UP</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.MouseEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when a user releases the pointing device button over an
- InteractiveObject instance.
- If the target is a SimpleButton instance, the object displays the <codeph class="+ topic/ph pr-d/codeph ">upState</codeph>
- display object.
- If the target is a selectable text field, the text field ends selection as the default
- behavior.
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.MouseEvent.MOUSE_OVER_mouseOver" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">mouseOver</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when the user moves a pointing device over an InteractiveObject instance.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.MouseEvent.MOUSE_OVER</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.MouseEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when the user moves a pointing device over an InteractiveObject instance.
- The <codeph class="+ topic/ph pr-d/codeph ">relatedObject</codeph> is the object that was previously under
- the pointing device.
- If the target is a SimpleButton instance, the object displays the <codeph class="+ topic/ph pr-d/codeph ">overState</codeph>
- or <codeph class="+ topic/ph pr-d/codeph ">upState</codeph> display object, depending on whether the mouse button is down, as the default behavior.
- <p class="- topic/p ">The <codeph class="+ topic/ph pr-d/codeph ">mouseOver</codeph> event is dispatched each time the mouse enters the area of any child object of the display object container,
- even if the mouse was already over another child object of the display object container.
- This is different behavior than the purpose of the <codeph class="+ topic/ph pr-d/codeph ">rollOver</codeph> event, which is to simplify the coding of rollout behaviors for
- display object containers with children. When the mouse enters the area of a display object or the area of any of its children from an object
- that is not one of its children, the display object dispatches the <codeph class="+ topic/ph pr-d/codeph ">rollOver</codeph> event.
- The <codeph class="+ topic/ph pr-d/codeph ">rollOver</codeph> events are dispatched consecutively down the parent chain of the object,
- starting with the highest parent that is neither the root nor an ancestor of the <codeph class="+ topic/ph pr-d/codeph ">relatedObject</codeph> and ending with the object.</p>
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.MouseEvent.MOUSE_OUT_mouseOut" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">mouseOut</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when the user moves a pointing device away from an InteractiveObject instance.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.MouseEvent.MOUSE_OUT</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.MouseEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when the user moves a pointing device away from an InteractiveObject instance.
- The event target is the object previously under the pointing device. The <codeph class="+ topic/ph pr-d/codeph ">relatedObject</codeph>
- is the object the pointing device has moved to.
- If the target is a SimpleButton instance, the button displays the <codeph class="+ topic/ph pr-d/codeph ">upState</codeph>
- display object as the default behavior.
- <p class="- topic/p ">The <codeph class="+ topic/ph pr-d/codeph ">mouseOut</codeph> event is dispatched each time the mouse leaves the
- area of any child object of the display object container, even if the mouse remains over another
- child object of the display object container. This is different behavior than the purpose of the <codeph class="+ topic/ph pr-d/codeph ">rollOut</codeph> event, which is to simplify the
- coding of rollover behaviors for display object containers with children. When the mouse leaves
- the area of a display object or the area of any of its children to go to an object that is not
- one of its children, the display object dispatches the <codeph class="+ topic/ph pr-d/codeph ">rollOut</codeph> event.The <codeph class="+ topic/ph pr-d/codeph ">rollOut</codeph> events are dispatched consecutively
- up the parent chain of the object, starting with the object and ending with the highest parent that is neither the root nor an
- ancestor of the <codeph class="+ topic/ph pr-d/codeph ">relatedObject</codeph>.</p>
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.MouseEvent.MOUSE_MOVE_mouseMove" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">mouseMove</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when a user moves the pointing device while it is over an InteractiveObject.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.MouseEvent.MOUSE_MOVE</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.MouseEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when a user moves the pointing device while it is over an InteractiveObject.
- If the target is a text field that the user is selecting, the selection is updated as the default behavior.
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.MouseEvent.MOUSE_DOWN_mouseDown" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">mouseDown</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when a user presses the pointing device button over an InteractiveObject instance.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.MouseEvent.MOUSE_DOWN</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.MouseEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when a user presses the pointing device button over an InteractiveObject instance.
- If the target is a SimpleButton instance, the SimpleButton instance displays the
- <codeph class="+ topic/ph pr-d/codeph ">downState</codeph> display object as the default behavior. If the target is a
- selectable text field, the text field begins selection as the default behavior.
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.MouseEvent.DOUBLE_CLICK_doubleClick" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">doubleClick</apiName><shortdesc class="- topic/shortdesc ">
- 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.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.MouseEvent.DOUBLE_CLICK</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.MouseEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- 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
- <codeph class="+ topic/ph pr-d/codeph ">doubleClickEnabled</codeph> flag is set to <codeph class="+ topic/ph pr-d/codeph ">true</codeph>.
- For a <codeph class="+ topic/ph pr-d/codeph ">doubleClick</codeph> event to occur, it must immediately follow the following
- series of events: <codeph class="+ topic/ph pr-d/codeph ">mouseDown</codeph>, <codeph class="+ topic/ph pr-d/codeph ">mouseUp</codeph>, <codeph class="+ topic/ph pr-d/codeph ">click</codeph>,
- <codeph class="+ topic/ph pr-d/codeph ">mouseDown</codeph>, <codeph class="+ topic/ph pr-d/codeph ">mouseUp</codeph>. All of these events must share the same
- target as the <codeph class="+ topic/ph pr-d/codeph ">doubleClick</codeph> event. The second click, represented by
- the second <codeph class="+ topic/ph pr-d/codeph ">mouseDown</codeph> and <codeph class="+ topic/ph pr-d/codeph ">mouseUp</codeph> events, must occur within
- a specific period of time after the <codeph class="+ topic/ph pr-d/codeph ">click</codeph> event. The allowable length of
- this period varies by operating system and can often be configured by the user.
- If the target is a selectable text field, the word under the pointer is selected as the
- default behavior. If the target InteractiveObject does not have its
- <codeph class="+ topic/ph pr-d/codeph ">doubleClickEnabled</codeph> flag set to <codeph class="+ topic/ph pr-d/codeph ">true</codeph> it receives two
- <codeph class="+ topic/ph pr-d/codeph ">click</codeph> events.
-
- <p class="- topic/p ">The <codeph class="+ topic/ph pr-d/codeph ">doubleClickEnabled</codeph> property defaults
- to <codeph class="+ topic/ph pr-d/codeph ">false</codeph>. </p>
-
- <p class="- topic/p ">The double-click text selection behavior of a TextField object
- is not related to the <codeph class="+ topic/ph pr-d/codeph ">doubleClick</codeph> event. Use
- <codeph class="+ topic/ph pr-d/codeph ">TextField.doubleClickEnabled</codeph> to control TextField selections.</p>
- </apiDesc></adobeApiEventDetail><related-links class="- topic/related-links "><link href="flash.display.xml#InteractiveObject/doubleClickEnabled" class="- topic/link "><linktext class="- topic/linktext ">doubleClickEnabled</linktext></link></related-links></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.MouseEvent.CLICK_click" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">click</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when a user presses and releases the main button of the user's
- pointing device over the same InteractiveObject.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.MouseEvent.CLICK</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.MouseEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when a user presses and releases the main button of the user's
- pointing device over the same InteractiveObject. For a click event to occur, it must always follow this series of
- events in the order of occurrence: mouseDown event, then mouseUp. The target object
- must be identical for both of these events; otherwise the <codeph class="+ topic/ph pr-d/codeph ">click</codeph> event does not
- occur. Any number of other mouse events can occur at any time between the
- <codeph class="+ topic/ph pr-d/codeph ">mouseDown</codeph> or <codeph class="+ topic/ph pr-d/codeph ">mouseUp</codeph> events; the <codeph class="+ topic/ph pr-d/codeph ">click</codeph> event
- still occurs.
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.FocusEvent.MOUSE_FOCUS_CHANGE_mouseFocusChange" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">mouseFocusChange</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when the user attempts to change focus by using a pointer device.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.FocusEvent.MOUSE_FOCUS_CHANGE</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.FocusEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when the user attempts to change focus by using a pointer device.
- The default behavior of this event is to change the focus and dispatch the corresponding
- <codeph class="+ topic/ph pr-d/codeph ">focusIn</codeph> and <codeph class="+ topic/ph pr-d/codeph ">focusOut</codeph> events.
-
- <p class="- topic/p ">This event is dispatched to the object that currently has focus. The related object for this event is the
- InteractiveObject instance that receives focus if you do not prevent the default behavior. You can prevent the change in
- focus by calling <codeph class="+ topic/ph pr-d/codeph ">preventDefault()</codeph> in an event listener that is properly registered with the target object.
- The <codeph class="+ topic/ph pr-d/codeph ">shiftKey</codeph> property is not used. Focus changes and
- <codeph class="+ topic/ph pr-d/codeph ">focusIn</codeph> and <codeph class="+ topic/ph pr-d/codeph ">focusOut</codeph> events are dispatched by default.</p>
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.FocusEvent.KEY_FOCUS_CHANGE_keyFocusChange" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">keyFocusChange</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when the user attempts to change focus by using keyboard navigation.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.FocusEvent.KEY_FOCUS_CHANGE</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.FocusEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when the user attempts to change focus by using keyboard navigation.
- The default behavior of this event is to change the focus and dispatch the
- corresponding <codeph class="+ topic/ph pr-d/codeph ">focusIn</codeph> and <codeph class="+ topic/ph pr-d/codeph ">focusOut</codeph> events.
-
- <p class="- topic/p ">This event is dispatched to the object that currently has focus.
- The related object for this event is the InteractiveObject instance that receives focus
- if you do not prevent the default behavior.
- You can prevent the change in focus by calling the <codeph class="+ topic/ph pr-d/codeph ">preventDefault()</codeph> method
- in an event listener that is properly registered with the target object.
- Focus changes and <codeph class="+ topic/ph pr-d/codeph ">focusIn</codeph> and <codeph class="+ topic/ph pr-d/codeph ">focusOut</codeph>
- events are dispatched by default.</p>
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.FocusEvent.FOCUS_OUT_focusOut" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">focusOut</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched after a display object loses focus.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.FocusEvent.FOCUS_OUT</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.FocusEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched <i class="+ topic/ph hi-d/i ">after</i> a display object loses focus.
- This happens when a user highlights a different object with a pointing device or keyboard navigation.
- The object that loses focus is called the target object of this event, while the corresponding InteractiveObject
- instance that receives focus is called the related object. A reference to the related object is stored in the target object's
- <codeph class="+ topic/ph pr-d/codeph ">relatedObject</codeph> property. The <codeph class="+ topic/ph pr-d/codeph ">shiftKey</codeph> property is not used. This event precedes the dispatch
- of the <codeph class="+ topic/ph pr-d/codeph ">focusIn</codeph> event by the related object.
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.FocusEvent.FOCUS_IN_focusIn" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">focusIn</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched after a display object gains focus.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.FocusEvent.FOCUS_IN</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.FocusEvent</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched <i class="+ topic/ph hi-d/i ">after</i> a display object gains focus.
- This situation happens when a user highlights the object with a pointing device or keyboard navigation.
- The recipient of such focus is called the target object of this event,
- while the corresponding InteractiveObject instance that lost focus because of this change is called the related object.
- A reference to the related object is stored in the receiving object's <codeph class="+ topic/ph pr-d/codeph ">relatedObject</codeph> property.
- The <codeph class="+ topic/ph pr-d/codeph ">shiftKey</codeph> property is not used.
- This event follows the dispatch of the previous object's <codeph class="+ topic/ph pr-d/codeph ">focusOut</codeph> event.
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.Event.SELECT_ALL_selectAll" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">selectAll</apiName><shortdesc class="- topic/shortdesc ">
- 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.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.Event.SELECT_ALL</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.Event</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- 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.
- This event is dispatched to the object that currently has focus.
- If the object that currently has focus is a TextField, the default behavior of this event is to cause
- all the contents of the text field to be selected.
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.Event.PASTE_paste" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">paste</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when the user activates the platform-specific accelerator key combination for a paste operation
- or selects 'Paste' from the text context menu.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.Event.PASTE</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.Event</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when the user activates the platform-specific accelerator key combination for a paste operation
- or selects 'Paste' from the text context menu.
- This event is dispatched to the object that currently has focus.
- If the object that currently has focus is a TextField, the default behavior of this event is to cause
- the contents of the clipboard to be pasted into the text field at the current insertion point
- replacing any currently selected text in the text field.
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.Event.CUT_cut" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">cut</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when the user activates the platform-specific accelerator key combination for a cut operation
- or selects 'Cut' from the text context menu.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.Event.CUT</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.Event</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when the user activates the platform-specific accelerator key combination for a cut operation
- or selects 'Cut' from the text context menu.
- This event is dispatched to the object that currently has focus.
- If the object that currently has focus is a TextField, the default behavior of this event is to cause
- any currently selected text in the text field to be cut to the clipboard.
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.Event.COPY_copy" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">copy</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when the user activates the platform-specific accelerator key combination for a copy operation
- or selects 'Copy' from the text context menu.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.Event.COPY</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.Event</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when the user activates the platform-specific accelerator key combination for a copy operation
- or selects 'Copy' from the text context menu.
- This event is dispatched to the object that currently has focus.
- If the object that currently has focus is a TextField, the default behavior of this event is to cause
- any currently selected text in the text field to be copied to the clipboard.
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:InteractiveObject_flash.events.Event.CLEAR_clear" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">clear</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.Event.CLEAR</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.Event</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu.
- This event is dispatched to the object that currently has focus.
- If the object that currently has focus is a TextField, the default behavior of this event is to cause
- any currently selected text in the text field to be deleted.
- </apiDesc></adobeApiEventDetail></adobeApiEvent><apiConstructor id="flash.display:InteractiveObject:InteractiveObject" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation apiOperation/apiConstructor"><apiName class="- topic/title reference/title apiRef/apiName ">InteractiveObject</apiName><shortdesc class="- topic/shortdesc ">
- Calling the new InteractiveObject() constructor
- throws an ArgumentError exception.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiConstructorDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail apiOperation/apiConstructorDetail"><apiConstructorDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiConstructorDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/></apiConstructorDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Calling the <codeph class="+ topic/ph pr-d/codeph ">new InteractiveObject()</codeph> constructor
- throws an <codeph class="+ topic/ph pr-d/codeph ">ArgumentError</codeph> exception.
- You can, however, call constructors for the following subclasses of InteractiveObject:
-
- <ul class="- topic/ul "><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">new SimpleButton()</codeph></li><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">new TextField()</codeph></li><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">new Loader()</codeph></li><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">new Sprite()</codeph></li><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">new MovieClip()</codeph></li></ul>
-
-
- </apiDesc></apiConstructorDetail></apiConstructor><apiOperation id="flash.display:InteractiveObject:requestSoftKeyboard" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">requestSoftKeyboard</apiName><shortdesc class="- topic/shortdesc ">
- Raises a virtual keyboard.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.2" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2.6" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">A value of <codeph class="+ topic/ph pr-d/codeph ">true</codeph> means that the soft keyboard request was granted; <codeph class="+ topic/ph pr-d/codeph ">false</codeph> means that the soft keyboard was not raised.
- </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Boolean</apiOperationClassifier></apiReturn><apiTipTexts><apiTipText class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiTipText ">If the current context supports it, show the keyboard.
- </apiTipText></apiTipTexts></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Raises a virtual keyboard.
-
- <p class="- topic/p ">Calling this method focuses the InteractiveObject instance and raises the soft keyboard, if necessary.
- The <codeph class="+ topic/ph pr-d/codeph ">needsSoftKeyboard</codeph> must also be <codeph class="+ topic/ph pr-d/codeph ">true</codeph>. A keyboard is not raised
- if a hardware keyboard is available, or if the client system does not support virtual keyboards.</p>
-
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> This method is not supported in AIR applications on iOS.</p>
-
- </apiDesc></apiOperationDetail><related-links class="- topic/related-links "><link href="flash.display.xml#InteractiveObject/needsSoftKeyboard" class="- topic/link "><linktext class="- topic/linktext ">needsSoftKeyboard</linktext></link></related-links></apiOperation><apiValue id="flash.display:InteractiveObject:accessibilityImplementation:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">accessibilityImplementation</apiName><shortdesc class="- topic/shortdesc ">
- The current accessibility implementation (AccessibilityImplementation)
- for this InteractiveObject instance.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.accessibility:AccessibilityImplementation</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- The current accessibility implementation (AccessibilityImplementation)
- for this InteractiveObject instance.
- </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.accessibility.xml#AccessibilityImplementation" class="- topic/link "><linktext class="- topic/linktext ">flash.accessibility.AccessibilityImplementation</linktext></link></related-links></apiValue><apiValue id="flash.display:InteractiveObject:contextMenu:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">contextMenu</apiName><shortdesc class="- topic/shortdesc ">
- Specifies the context menu associated with this object.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.display:NativeMenu</apiValueClassifier><apiTipTexts><apiTipText class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiTipText ">The context menu associated with this object
- </apiTipText></apiTipTexts></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Specifies the context menu associated with this object.
-
- <p class="- topic/p ">For content running in Flash Player, this property is a ContextMenu object. In the AIR runtime,
- the ContextMenu class extends the NativeMenu class, however Flash Player only supports the
- ContextMenu class, not the NativeMenu class.
- </p>
-
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> TextField objects always include a clipboard menu in the context menu. The clipboard menu contains
- Cut, Copy, Paste, Clear, and Select All commands. You cannot remove these commands from the context menu for TextField objects.
- For TextField objects, selecting these commands (or their keyboard equivalents) does not generate <codeph class="+ topic/ph pr-d/codeph ">clear</codeph>,
- <codeph class="+ topic/ph pr-d/codeph ">copy</codeph>, <codeph class="+ topic/ph pr-d/codeph ">cut</codeph>, <codeph class="+ topic/ph pr-d/codeph ">paste</codeph>, or <codeph class="+ topic/ph pr-d/codeph ">selectAll</codeph> events.</p>
-
- </apiDesc><example conref="examples\ContextMenu_custom.as" class="- topic/example "> The following example shows how you can add a custom context menu item to a Sprite object by setting the Sprite's contextMenu property to a ContextMenu object.
- Example provided by
- <xref href="http://actionscriptexamples.com/2009/03/05/creating-a-custom-context-menu-item-in-flash-using-actionscript-30/" scope="_mmexternal" class="- topic/xref "> ActionScriptExamples.com</xref>.
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- var red_cmi:ContextMenuItem = new ContextMenuItem("red");
- red_cmi.addEventListener(ContextMenuEvent.MENU_ITEM_SELECT, cmi_menuItemSelect);
-
- var cm:ContextMenu = new ContextMenu();
- cm.customItems.push(red_cmi);
- cm.hideBuiltInItems();
-
- var spr:Sprite = new Sprite();
- spr.contextMenu = cm;
- spr.graphics.beginFill(0x000000);
- spr.graphics.drawRect(0, 0, 120, 90);
- spr.graphics.endFill();
- spr.x = 10;
- spr.y = 10;
- addChild(spr);
-
- function cmi_menuItemSelect(evt:ContextMenuEvent):void {
- spr.graphics.clear();
- spr.graphics.beginFill(0xFF0000);
- spr.graphics.drawRect(0, 0, 120, 90);
- spr.graphics.endFill();
- }
- </codeblock></example></apiValueDetail></apiValue><apiValue id="flash.display:InteractiveObject:doubleClickEnabled:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">doubleClickEnabled</apiName><shortdesc class="- topic/shortdesc ">
- Specifies whether the object receives doubleClick events.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Boolean</apiValueClassifier><apiTipTexts><apiTipText class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiTipText ">Whether this object receives double click messages.
-
-
- </apiTipText></apiTipTexts></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Specifies whether the object receives <codeph class="+ topic/ph pr-d/codeph ">doubleClick</codeph> events. The default value
- is <codeph class="+ topic/ph pr-d/codeph ">false</codeph>, which means that by default an InteractiveObject instance does not receive
- <codeph class="+ topic/ph pr-d/codeph ">doubleClick</codeph> events. If the <codeph class="+ topic/ph pr-d/codeph ">doubleClickEnabled</codeph> property is set to
- <codeph class="+ topic/ph pr-d/codeph ">true</codeph>, the instance receives <codeph class="+ topic/ph pr-d/codeph ">doubleClick</codeph> events within its bounds.
- The <codeph class="+ topic/ph pr-d/codeph ">mouseEnabled</codeph> property of the InteractiveObject instance must also be
- set to <codeph class="+ topic/ph pr-d/codeph ">true</codeph> for the object to receive <codeph class="+ topic/ph pr-d/codeph ">doubleClick</codeph> events.
-
- <p class="- topic/p ">No event is dispatched by setting this property. You must use the
- <codeph class="+ topic/ph pr-d/codeph ">addEventListener()</codeph> method to add an event listener
- for the <codeph class="+ topic/ph pr-d/codeph ">doubleClick</codeph> event.</p>
-
- </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.display.xml#InteractiveObject/event:doubleClick" class="- topic/link "><linktext class="- topic/linktext ">doubleClick</linktext></link><link href="flash.display.xml#InteractiveObject/mouseEnabled" class="- topic/link "><linktext class="- topic/linktext ">mouseEnabled</linktext></link><link href="flash.display.xml#DisplayObjectContainer/mouseChildren" class="- topic/link "><linktext class="- topic/linktext ">flash.display.DisplayObjectContainer.mouseChildren</linktext></link></related-links></apiValue><apiValue id="flash.display:InteractiveObject:focusRect:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">focusRect</apiName><shortdesc class="- topic/shortdesc ">
- Specifies whether this object displays a focus rectangle.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata><asCustoms class="+ topic/metadata adobe-api-d/asCustoms "><internal>FP IMD: See the AS2 MovieClip._focusRect, Button._focusRect, and
- _focusRect (global property) topics for information to migrate to the ASDoc description of this
- AS3 property.
-
-
- </internal></asCustoms></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Object</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Specifies whether this object displays a focus rectangle. It can take one of three
- values: <codeph class="+ topic/ph pr-d/codeph ">true</codeph>, <codeph class="+ topic/ph pr-d/codeph ">false</codeph>, or <codeph class="+ topic/ph pr-d/codeph ">null</codeph>. Values of <codeph class="+ topic/ph pr-d/codeph ">true</codeph>
- and <codeph class="+ topic/ph pr-d/codeph ">false</codeph> work as expected, specifying whether or not the focus rectangle
- appears. A value of <codeph class="+ topic/ph pr-d/codeph ">null</codeph> indicates that this object obeys the
- <codeph class="+ topic/ph pr-d/codeph ">stageFocusRect</codeph> property of the Stage.
-
- </apiDesc></apiValueDetail></apiValue><apiValue id="flash.display:InteractiveObject:mouseEnabled:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">mouseEnabled</apiName><shortdesc class="- topic/shortdesc ">
- Specifies whether this object receives mouse, or other user input, messages.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Boolean</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Specifies whether this object receives mouse, or other user input, messages. The default value is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>,
- which means that by default any InteractiveObject instance that is on the display list
- receives mouse events or other user input events.
- If <codeph class="+ topic/ph pr-d/codeph ">mouseEnabled</codeph> is set to <codeph class="+ topic/ph pr-d/codeph ">false</codeph>, the instance does not receive any
- mouse events (or other user input events like keyboard events). Any children of this instance on the display list are not affected. To change
- the <codeph class="+ topic/ph pr-d/codeph ">mouseEnabled</codeph> behavior for all children of an object on the display list, use
- <codeph class="+ topic/ph pr-d/codeph ">flash.display.DisplayObjectContainer.mouseChildren</codeph>.
- <p class="- topic/p "> No event is dispatched by setting this property. You must use the
- <codeph class="+ topic/ph pr-d/codeph ">addEventListener()</codeph> method to create interactive functionality.</p>
-
- </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.display.xml#DisplayObjectContainer/mouseChildren" class="- topic/link "><linktext class="- topic/linktext ">flash.display.DisplayObjectContainer.mouseChildren</linktext></link></related-links></apiValue><apiValue id="flash.display:InteractiveObject:needsSoftKeyboard:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">needsSoftKeyboard</apiName><shortdesc class="- topic/shortdesc ">
- Specifies whether a virtual keyboard (an on-screen, software keyboard) should display
- when this InteractiveObject instance receives focus.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.2" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2.6" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Boolean</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Specifies whether a virtual keyboard (an on-screen, software keyboard) should display
- when this InteractiveObject instance receives focus.
-
- <p class="- topic/p ">By default, the value is <codeph class="+ topic/ph pr-d/codeph ">false</codeph> and focusing an InteractiveObject instance does
- not raise a soft keyboard. If the <codeph class="+ topic/ph pr-d/codeph ">needsSoftKeyboard</codeph> property is set to <codeph class="+ topic/ph pr-d/codeph ">true</codeph>,
- the runtime raises a soft keyboard when the InteractiveObject instance is ready to accept user input.
- An InteractiveObject instance is ready to accept user input after a programmatic call to set the Stage
- <codeph class="+ topic/ph pr-d/codeph ">focus</codeph> property or a user interaction, such as a "tap." If the client system has a
- hardware keyboard available or does not support virtual keyboards, then the soft keyboard is not raised.</p>
-
- <p class="- topic/p ">The InteractiveObject instance dispatches <codeph class="+ topic/ph pr-d/codeph ">softKeyboardActivating</codeph>,
- <codeph class="+ topic/ph pr-d/codeph ">softKeyboardActivate</codeph>, and <codeph class="+ topic/ph pr-d/codeph ">softKeyboardDeactivate</codeph> events
- when the soft keyboard raises and lowers.</p>
-
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> This property is not supported in AIR applications on iOS.</p>
-
- </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.display.xml#InteractiveObject/event:softKeyboardActivating" class="- topic/link "><linktext class="- topic/linktext ">softKeyboardActivating</linktext></link><link href="flash.display.xml#InteractiveObject/event:softKeyboardActivate" class="- topic/link "><linktext class="- topic/linktext ">softKeyboardActivate</linktext></link><link href="flash.display.xml#InteractiveObject/event:softKeyboardDeactivate" class="- topic/link "><linktext class="- topic/linktext ">softKeyboardDeactivate</linktext></link></related-links></apiValue><apiValue id="flash.display:InteractiveObject:softKeyboardInputAreaOfInterest:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">softKeyboardInputAreaOfInterest</apiName><shortdesc class="- topic/shortdesc ">
- Defines the area that should remain on-screen when a soft keyboard is displayed.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10.2" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2.6" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.geom:Rectangle</apiValueClassifier><apiTipTexts><apiTipText class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiTipText ">Sets the area to be displayed on-screen when the soft keyboard opens.
- </apiTipText></apiTipTexts></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Defines the area that should remain on-screen when a soft keyboard is displayed.
-
- <p class="- topic/p ">If the <codeph class="+ topic/ph pr-d/codeph ">needsSoftKeyboard</codeph> property of this InteractiveObject is
- <codeph class="+ topic/ph pr-d/codeph ">true</codeph>, then the runtime adjusts the display as needed to keep the
- object in view while the user types. Ordinarily, the runtime uses the object
- bounds obtained from the <codeph class="+ topic/ph pr-d/codeph ">DisplayObject.getBounds()</codeph> method. You can
- specify a different area using this <codeph class="+ topic/ph pr-d/codeph ">softKeyboardInputAreaOfInterest</codeph>
- property.</p>
-
- <p class="- topic/p ">Specify the <codeph class="+ topic/ph pr-d/codeph ">softKeyboardInputAreaOfInterest</codeph> in stage coordinates.</p>
-
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> On Android, the <codeph class="+ topic/ph pr-d/codeph ">softKeyboardInputAreaOfInterest</codeph> is not
- respected in landscape orientations.</p>
-
- </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.display.xml#DisplayObject/getBounds()" class="- topic/link "><linktext class="- topic/linktext ">flash.display.DisplayObject.getBounds()</linktext></link></related-links></apiValue><apiValue id="flash.display:InteractiveObject:tabEnabled:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">tabEnabled</apiName><shortdesc class="- topic/shortdesc ">
- Specifies whether this object is in the tab order.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata><asCustoms class="+ topic/metadata adobe-api-d/asCustoms "><internal>FP IMD: See the AS2 MovieClip.tabEnabled, Button.tabEnabled, and
- TextField.tabEnabled topics for information to migrate to the ASDoc description of this
- AS3 property.
-
-
- </internal></asCustoms></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Boolean</apiValueClassifier><apiTipTexts><apiTipText class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiTipText ">Whether this object is in the tab order.
-
- </apiTipText></apiTipTexts></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Specifies whether this object is in the tab order. If this object is in the tab order,
- the value is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>; otherwise, the value is <codeph class="+ topic/ph pr-d/codeph ">false</codeph>. By default,
- the value is <codeph class="+ topic/ph pr-d/codeph ">false</codeph>, except for the following:
- <ul class="- topic/ul "><li class="- topic/li ">For a SimpleButton object, the value is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>.</li><li class="- topic/li ">For a TextField object with <codeph class="+ topic/ph pr-d/codeph ">type = "input"</codeph>, the value is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>.</li><li class="- topic/li ">For a Sprite object or MovieClip object with <codeph class="+ topic/ph pr-d/codeph ">buttonMode = true</codeph>, the value is <codeph class="+ topic/ph pr-d/codeph ">true</codeph>.</li></ul>
-
- </apiDesc></apiValueDetail></apiValue><apiValue id="flash.display:InteractiveObject:tabIndex:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">tabIndex</apiName><shortdesc class="- topic/shortdesc ">
- Specifies the tab ordering of objects in a SWF file.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">int</apiValueClassifier><apiTipTexts><apiTipText class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiTipText ">The tab index for this object.
-
-
- </apiTipText></apiTipTexts></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Specifies the tab ordering of objects in a SWF file. The <codeph class="+ topic/ph pr-d/codeph ">tabIndex</codeph>
- property is -1 by default, meaning no tab index is set for the object.
-
- <p class="- topic/p ">If any currently displayed object in the SWF file contains a <codeph class="+ topic/ph pr-d/codeph ">tabIndex</codeph> property, automatic
- tab ordering is disabled, and the tab ordering is calculated from the <codeph class="+ topic/ph pr-d/codeph ">tabIndex</codeph> properties of
- objects in the SWF file. The custom tab ordering includes only objects that have <codeph class="+ topic/ph pr-d/codeph ">tabIndex</codeph>
- properties.</p>
-
- <p class="- topic/p ">The <codeph class="+ topic/ph pr-d/codeph ">tabIndex</codeph> property can be a non-negative integer. The objects are ordered according to
- their <codeph class="+ topic/ph pr-d/codeph ">tabIndex</codeph> properties, in ascending order. An object with a <codeph class="+ topic/ph pr-d/codeph ">tabIndex</codeph>
- value of 1 precedes an object with a <codeph class="+ topic/ph pr-d/codeph ">tabIndex</codeph> value of 2. Do not use the same <codeph class="+ topic/ph pr-d/codeph ">tabIndex</codeph>
- value for multiple objects.</p>
-
- <p class="- topic/p ">The custom tab ordering that the <codeph class="+ topic/ph pr-d/codeph ">tabIndex</codeph> property defines is <i class="+ topic/ph hi-d/i ">flat</i>.
- This means that no attention is paid to the hierarchical relationships of objects in the SWF file.
- All objects in the SWF file with <codeph class="+ topic/ph pr-d/codeph ">tabIndex</codeph> properties are placed in the tab order, and the
- tab order is determined by the order of the <codeph class="+ topic/ph pr-d/codeph ">tabIndex</codeph> values. </p>
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> To set the tab order for TLFTextField instances, cast the display object child
- of the TLFTextField as an InteractiveObject, then set the <codeph class="+ topic/ph pr-d/codeph ">tabIndex</codeph> property. For example:
- <pre xml:space="preserve" class="- topic/pre ">
- InteractiveObject(tlfInstance.getChildAt(1)).tabIndex = 3;
- </pre>
- To reverse the tab order from the default setting for three instances of a TLFTextField object
- (<codeph class="+ topic/ph pr-d/codeph ">tlfInstance1</codeph>, <codeph class="+ topic/ph pr-d/codeph ">tlfInstance2</codeph> and <codeph class="+ topic/ph pr-d/codeph ">tlfInstance3</codeph>), use:
- <pre xml:space="preserve" class="- topic/pre ">
- InteractiveObject(tlfInstance1.getChildAt(1)).tabIndex = 3;
- InteractiveObject(tlfInstance2.getChildAt(1)).tabIndex = 2;
- InteractiveObject(tlfInstance3.getChildAt(1)).tabIndex = 1;
- </pre>
- </p>
-
- </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier languages="" id="flash.display:GraphicsTrianglePath" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">GraphicsTrianglePath</apiName><shortdesc class="- topic/shortdesc ">
- Defines an ordered set of triangles that can be rendered using
- either (u,v) fill coordinates or a normal fill.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiFinal class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiFinal "/><apiBaseInterface>flash.display:IGraphicsPath</apiBaseInterface><apiBaseInterface>flash.display:IGraphicsData</apiBaseInterface><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">Object</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Defines an ordered set of triangles that can be rendered using
- either (u,v) fill coordinates or a normal fill.
-
- Each triangle in the path is represented by three sets of (x, y)
- coordinates, each of which is one point of the triangle.
-
- <p class="- topic/p ">
- The triangle vertices do not contain z coordinates and do not necessarily
- represent 3D faces. However a triangle path can be used to support the rendering
- of 3D geometry in a 2D space.
- </p>
-
- </apiDesc></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.display.xml#Graphics/drawTriangles()" class="- topic/link "><linktext class="- topic/linktext ">flash.display.Graphics.drawTriangles()</linktext></link></related-links><apiConstructor id="flash.display:GraphicsTrianglePath:GraphicsTrianglePath" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation apiOperation/apiConstructor"><apiName class="- topic/title reference/title apiRef/apiName ">GraphicsTrianglePath</apiName><shortdesc class="- topic/shortdesc ">
- Creates a new GraphicsTrianglePath object.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiConstructorDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail apiOperation/apiConstructorDetail"><apiConstructorDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiConstructorDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">vertices</apiItemName><apiType value="Vector$Number" name="type" class="- topic/state reference/state apiRef/apiType "/><apiData class="- topic/ph reference/ph apiRef/apiData ">null</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">A Vector of Numbers where each pair of numbers is treated as a point (an x, y pair). Required.
-
- </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">indices</apiItemName><apiType value="Vector$int" name="type" class="- topic/state reference/state apiRef/apiType "/><apiData class="- topic/ph reference/ph apiRef/apiData ">null</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">A Vector of integers or indexes, where every three indexes define a triangle.
-
- </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">uvtData</apiItemName><apiType value="Vector$Number" name="type" class="- topic/state reference/state apiRef/apiType "/><apiData class="- topic/ph reference/ph apiRef/apiData ">null</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">A Vector of normalized coordinates used to apply texture mapping.
-
- </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">culling</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">String</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">none</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">Specifies whether to render triangles that face in a given direction. Used to
- prevent the rendering of triangles that cannot be seen in the current view.
- Can be set to any value defined by the TriangleCulling class.
-
- </apiDesc></apiParam></apiConstructorDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Creates a new GraphicsTrianglePath object.
-
- </apiDesc></apiConstructorDetail><related-links class="- topic/related-links "><link href="flash.display.xml#GraphicsTrianglePath/culling" class="- topic/link "><linktext class="- topic/linktext ">culling</linktext></link><link href="flash.display.xml#TriangleCulling" class="- topic/link "><linktext class="- topic/linktext ">flash.display.TriangleCulling</linktext></link></related-links></apiConstructor><apiValue id="flash.display:GraphicsTrianglePath:indices" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">indices</apiName><shortdesc class="- topic/shortdesc ">
- A Vector of integers or indexes, where every three indexes define a triangle.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiType value="Vector$int" name="type" class="- topic/state reference/state apiRef/apiType "/></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- A Vector of integers or indexes, where every three indexes define a triangle. If the indexes parameter
- is null then every three vertices (six x,y pairs in the vertices Vector) defines a triangle.
- Otherwise each index refers to a vertex, which is a pair of numbers in the vertices Vector.
- For example <codeph class="+ topic/ph pr-d/codeph ">indexes[1]</codeph> refers to (<codeph class="+ topic/ph pr-d/codeph ">vertices[2]</codeph>, <codeph class="+ topic/ph pr-d/codeph ">vertices[3]</codeph>).
- </apiDesc></apiValueDetail></apiValue><apiValue id="flash.display:GraphicsTrianglePath:uvtData" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">uvtData</apiName><shortdesc class="- topic/shortdesc ">
- A Vector of normalized coordinates used to apply texture mapping.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiType value="Vector$Number" name="type" class="- topic/state reference/state apiRef/apiType "/></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- A Vector of normalized coordinates used to apply texture mapping.
- Each coordinate refers to a point on the bitmap used for the fill.
- There must be one UV or one UVT coordinate per vertex.
-
- <p class="- topic/p ">
- In UV coordinates, (0,0) is the upper left of the bitmap, and (1,1) is the lower right of the bitmap.
- </p>
-
- <p class="- topic/p ">
- If the length of this vector is twice the length of the <codeph class="+ topic/ph pr-d/codeph ">vertices</codeph> vector then normalized
- coordinates are used without perspective correction.
- </p>
-
- <p class="- topic/p ">
- If the length of this vector is three times the length of the <codeph class="+ topic/ph pr-d/codeph ">vertices</codeph> vector then the
- third coordinate is interpreted as 't', the distance from the eye to the texture in eye space.
- This helps the rendering engine correctly apply perspective when mapping textures in 3D.
- </p>
- </apiDesc></apiValueDetail></apiValue><apiValue id="flash.display:GraphicsTrianglePath:vertices" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">vertices</apiName><shortdesc class="- topic/shortdesc ">
- A Vector of Numbers where each pair of numbers is treated as a point (an x, y pair).</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiType value="Vector$Number" name="type" class="- topic/state reference/state apiRef/apiType "/></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- A Vector of Numbers where each pair of numbers is treated as a point (an x, y pair).
- </apiDesc></apiValueDetail></apiValue><apiValue id="flash.display:GraphicsTrianglePath:culling:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">culling</apiName><shortdesc class="- topic/shortdesc ">
- Specifies whether to render triangles that face in a given direction.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Specifies whether to render triangles that face in a given direction. Used to
- prevent the rendering of triangles that cannot be seen in the current view.
- <p class="- topic/p ">
- Can be set to any value defined by the TriangleCulling class.
- </p>
-
- </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.display.xml#TriangleCulling" class="- topic/link "><linktext class="- topic/linktext ">flash.display.TriangleCulling</linktext></link></related-links></apiValue></apiClassifier><apiClassifier languages="" id="flash.display:DisplayObject" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">DisplayObject</apiName><shortdesc class="- topic/shortdesc ">
- The DisplayObject class is the base class for all objects that can be placed on
- the display list.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiBaseInterface>flash.display:IBitmapDrawable</apiBaseInterface><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">flash.events:EventDispatcher</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- The DisplayObject class is the base class for all objects that can be placed on
- the display list. The display list manages all objects displayed in the Flash runtimes.
- Use the DisplayObjectContainer class to arrange the display objects in the display list.
- DisplayObjectContainer objects can have child display objects, while other display objects, such as
- Shape and TextField objects, are "leaf" nodes that have only parents and siblings, no children.
-
- <p class="- topic/p ">The DisplayObject class supports basic functionality like the <i class="+ topic/ph hi-d/i ">x</i> and <i class="+ topic/ph hi-d/i ">y</i> position of
- an object, as well as more advanced properties of the object such as its transformation matrix.
- </p>
-
- <p class="- topic/p ">DisplayObject is an abstract base class; therefore, you cannot call DisplayObject directly. Invoking
- <codeph class="+ topic/ph pr-d/codeph ">new DisplayObject()</codeph> throws an <codeph class="+ topic/ph pr-d/codeph ">ArgumentError</codeph> exception. </p>
-
- <p class="- topic/p ">All display objects inherit from the DisplayObject class.</p>
-
- <p class="- topic/p ">The DisplayObject class itself does not include any APIs for rendering content onscreen.
- For that reason, if you want create a custom subclass of the DisplayObject class, you will want
- to extend one of its subclasses that do have APIs for rendering content onscreen,
- such as the Shape, Sprite, Bitmap, SimpleButton, TextField, or MovieClip class.</p>
-
- <p class="- topic/p ">The DisplayObject class contains several broadcast events. Normally, the target
- of any particular event is a specific DisplayObject instance. For example,
- the target of an <codeph class="+ topic/ph pr-d/codeph ">added</codeph> event is the specific DisplayObject instance
- that was added to the display list. Having a single target restricts the placement of
- event listeners to that target and in some cases the target's ancestors on the display list.
- With broadcast events, however, the target is not a specific DisplayObject instance,
- but rather all DisplayObject instances, including those that are not on the display list.
- This means that you can add a listener to any DisplayObject instance to listen for broadcast events.
- In addition to the broadcast events listed in the DisplayObject class's Events table,
- the DisplayObject class also inherits two broadcast events from the EventDispatcher
- class: <codeph class="+ topic/ph pr-d/codeph ">activate</codeph> and <codeph class="+ topic/ph pr-d/codeph ">deactivate</codeph>.</p>
-
- <p class="- topic/p ">Some properties previously used in the ActionScript 1.0 and 2.0 MovieClip, TextField, and Button
- classes (such as <codeph class="+ topic/ph pr-d/codeph ">_alpha</codeph>, <codeph class="+ topic/ph pr-d/codeph ">_height</codeph>, <codeph class="+ topic/ph pr-d/codeph ">_name</codeph>, <codeph class="+ topic/ph pr-d/codeph ">_width</codeph>,
- <codeph class="+ topic/ph pr-d/codeph ">_x</codeph>, <codeph class="+ topic/ph pr-d/codeph ">_y</codeph>, and others) have equivalents in the ActionScript 3.0
- DisplayObject class that are renamed so that they no longer begin with the underscore (_) character.</p>
-
- <p class="- topic/p ">For more information, see the "Display Programming" chapter of the <i class="+ topic/ph hi-d/i ">ActionScript 3.0 Developer's Guide</i>.</p>
-
- </apiDesc><example conref="examples\DisplayObjectExample.as" class="- topic/example "> The following example uses the <codeph class="+ topic/ph pr-d/codeph ">DisplayObjectExample</codeph> class to
- draw an orange square in the corner of the Stage and then respond to events by displaying text
- information for each event. This task is accomplished by performing the following steps:
- <ol class="- topic/ol "><li class="- topic/li ">Class properties are declared for the color and size of the square.</li><li class="- topic/li ">The constructor calls the <codeph class="+ topic/ph pr-d/codeph ">draw()</codeph> method, which draws an orange square on
- the Stage at the default coordinates of <i class="+ topic/ph hi-d/i ">x = 0, y = 0</i>.</li><li class="- topic/li ">The following event listener methods are attached to the square:
- <ul class="- topic/ul "><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">addedHandler()</codeph> listens for <codeph class="+ topic/ph pr-d/codeph ">added</codeph> events, dispatched when the
- square is added to the display list.</li><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">enterFrameHandler()</codeph> listens for <codeph class="+ topic/ph pr-d/codeph ">enterFrame</codeph> events, which have no
- real meaning in this example.</li><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">removedHandler()</codeph> listens for <codeph class="+ topic/ph pr-d/codeph ">removed</codeph> events, dispatched when
- the square is removed from the display list, which happens when the square is clicked.</li><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">clickHandler()</codeph> listens for <codeph class="+ topic/ph pr-d/codeph ">click</codeph> events, dispatched when the
- orange square is clicked.</li><li class="- topic/li "><codeph class="+ topic/ph pr-d/codeph ">renderHandler()</codeph> listens for <codeph class="+ topic/ph pr-d/codeph ">render</codeph> events after the display
- list is updated.</li></ul></li></ol>
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- package {
- import flash.display.Sprite;
- public class DisplayObjectExample extends Sprite {
- public function DisplayObjectExample() {
- var child:CustomDisplayObject = new CustomDisplayObject();
- addChild(child);
- }
- }
- }
- import flash.display.DisplayObject;
- import flash.display.Sprite;
- import flash.display.Stage;
- import flash.display.StageAlign;
- import flash.display.StageScaleMode;
- import flash.events.*;
- class CustomDisplayObject extends Sprite {
- private var bgColor:uint = 0xFFCC00;
- private var size:uint = 80;
- public function CustomDisplayObject() {
- draw();
- addEventListener(Event.ADDED, addedHandler);
- addEventListener(Event.ENTER_FRAME, enterFrameHandler);
- addEventListener(Event.REMOVED, removedHandler);
- addEventListener(MouseEvent.CLICK, clickHandler);
- addEventListener(Event.RENDER, renderHandler);
- }
- private function draw():void {
- graphics.beginFill(bgColor);
- graphics.drawRect(0, 0, size, size);
- graphics.endFill();
- }
- private function clickHandler(event:MouseEvent):void {
- trace("clickHandler: " + event);
- parent.removeChild(this);
- }
- private function addedHandler(event:Event):void {
- trace("addedHandler: " + event);
- stage.scaleMode = StageScaleMode.NO_SCALE;
- stage.align = StageAlign.TOP_LEFT;
- stage.addEventListener("resize", resizeHandler);
- }
- private function enterFrameHandler(event:Event):void {
- trace("enterFrameHandler: " + event);
- removeEventListener("enterFrame", enterFrameHandler);
- }
- private function removedHandler(event:Event):void {
- trace("removedHandler: " + event);
- stage.removeEventListener("resize", resizeHandler);
- }
- private function renderHandler(event:Event):void {
- trace("renderHandler: " + event);
- }
- private function resizeHandler(event:Event):void {
- trace("resizeHandler: " + event);
- }
- }
- </codeblock></example></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.display.xml#DisplayObjectContainer" class="- topic/link "><linktext class="- topic/linktext ">flash.display.DisplayObjectContainer</linktext></link></related-links><adobeApiEvent id="flash.display:DisplayObject_flash.events.Event.RENDER_render" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">render</apiName><shortdesc class="- topic/shortdesc ">
- [broadcast event] Dispatched when the display list is about to be updated and rendered.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.Event.RENDER</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.Event</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- [broadcast event] Dispatched when the display list is about to be updated and rendered. This event provides the last opportunity
- for objects listening for this event to make changes before the display list is rendered.
- You must call the <codeph class="+ topic/ph pr-d/codeph ">invalidate()</codeph> method
- of the Stage object
- each time you want a <codeph class="+ topic/ph pr-d/codeph ">render</codeph> event to be dispatched. <codeph class="+ topic/ph pr-d/codeph ">Render</codeph> events
- are dispatched to an object only if there is mutual trust between it and the object that called
- <codeph class="+ topic/ph pr-d/codeph ">Stage.invalidate()</codeph>.
- This event is a broadcast event, which means that it is dispatched
- by all display objects with a listener registered for this event.
-
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note: </b>This event is not dispatched if the display is
- not rendering. This is the case when the content is either minimized or obscured. </p>
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:DisplayObject_flash.events.Event.REMOVED_FROM_STAGE_removedFromStage" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">removedFromStage</apiName><shortdesc class="- topic/shortdesc ">
- 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.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9.0.28.0" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.Event.REMOVED_FROM_STAGE</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.Event</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- 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.
- Two methods of the DisplayObjectContainer class generate this event:
- <codeph class="+ topic/ph pr-d/codeph ">removeChild()</codeph> and <codeph class="+ topic/ph pr-d/codeph ">removeChildAt()</codeph>.
-
- <p class="- topic/p ">The following methods of a DisplayObjectContainer object also generate this event if an object must be removed
- to make room for the new object: <codeph class="+ topic/ph pr-d/codeph ">addChild()</codeph>, <codeph class="+ topic/ph pr-d/codeph ">addChildAt()</codeph>, and
- <codeph class="+ topic/ph pr-d/codeph ">setChildIndex()</codeph>. </p>
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:DisplayObject_flash.events.Event.REMOVED_removed" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">removed</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when a display object is about to be removed from the display list.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.Event.REMOVED</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.Event</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when a display object is about to be removed from the display list.
- Two methods of the DisplayObjectContainer class generate this event:
- <codeph class="+ topic/ph pr-d/codeph ">removeChild()</codeph> and <codeph class="+ topic/ph pr-d/codeph ">removeChildAt()</codeph>.
-
- <p class="- topic/p ">The following methods of a DisplayObjectContainer object also generate this event if an object must be removed
- to make room for the new object: <codeph class="+ topic/ph pr-d/codeph ">addChild()</codeph>, <codeph class="+ topic/ph pr-d/codeph ">addChildAt()</codeph>, and
- <codeph class="+ topic/ph pr-d/codeph ">setChildIndex()</codeph>. </p>
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:DisplayObject_flash.events.Event.EXIT_FRAME_exitFrame" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">exitFrame</apiName><shortdesc class="- topic/shortdesc ">
- [broadcast event] Dispatched when the playhead is exiting the current frame.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.Event.EXIT_FRAME</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.Event</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- [broadcast event] Dispatched when the playhead is exiting the current frame.
- All frame scripts have been run. If the playhead is not moving, or if there is only one frame, this event
- is dispatched continuously in conjunction with the frame rate.
- This event is a broadcast event, which means that it is dispatched
- by all display objects with a listener registered for this event.
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:DisplayObject_flash.events.Event.FRAME_CONSTRUCTED_frameConstructed" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">frameConstructed</apiName><shortdesc class="- topic/shortdesc ">
- [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="2" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.Event.FRAME_CONSTRUCTED</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.Event</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.
- If the playhead is not moving, or if there is only one frame, this event
- is dispatched continuously in conjunction with the frame rate.
- This event is a broadcast event, which means that it is dispatched
- by all display objects with a listener registered for this event.
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:DisplayObject_flash.events.Event.ENTER_FRAME_enterFrame" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">enterFrame</apiName><shortdesc class="- topic/shortdesc ">
- [broadcast event] Dispatched when the playhead is entering a new
- frame.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.Event.ENTER_FRAME</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.Event</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- [broadcast event] Dispatched when the playhead is entering a new
- frame. If the playhead is not moving, or if there is only one frame, this event
- is dispatched continuously in conjunction with the frame rate.
- This event is a broadcast event, which means that it is dispatched
- by all display objects with a listener registered for this event.
- </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="flash.display:DisplayObject_flash.events.Event.ADDED_TO_STAGE_addedToStage" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">addedToStage</apiName><shortdesc class="- topic/shortdesc ">
- 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.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9.0.28.0" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.Event.ADDED_TO_STAGE</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.Event</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- 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. The
- following methods trigger this event: <codeph class="+ topic/ph pr-d/codeph ">DisplayObjectContainer.addChild()</codeph>,
- <codeph class="+ topic/ph pr-d/codeph ">DisplayObjectContainer.addChildAt()</codeph>.
- </apiDesc></adobeApiEventDetail><related-links class="- topic/related-links "><link href="flash.display.xml#DisplayObjectContainer/addChild()" class="- topic/link "><linktext class="- topic/linktext ">flash.display.DisplayObjectContainer.addChild()</linktext></link><link href="flash.display.xml#DisplayObjectContainer/addChildAt()" class="- topic/link "><linktext class="- topic/linktext ">flash.display.DisplayObjectContainer.addChildAt()</linktext></link></related-links></adobeApiEvent><adobeApiEvent id="flash.display:DisplayObject_flash.events.Event.ADDED_added" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef adobeApiEvent/adobeApiEvent "><apiName class="- topic/title reference/title apiRef/apiName ">added</apiName><shortdesc class="- topic/shortdesc ">
- Dispatched when a display object is added to the display list.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><adobeApiEventDetail class="- topic/body reference/refbody apiRef/apiDetail adobeApiEvent/adobeApiEventDetail "><adobeApiEventDef class="- topic/section reference/section apiRef/apiDef adobeApiEvent/adobeApiEventDef "><apiEventType class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiEventType ">flash.events.Event.ADDED</apiEventType><adobeApiEventClassifier class="- topic/xref reference/xref apiRef/apiRelation adobeApiEvent/adobeApiEventClassifier ">flash.events.Event</adobeApiEventClassifier><apiGeneratedEvent class="- topic/state reference/state apiRef/apiQualifier adobeApiEvent/apiGeneratedEvent "/></adobeApiEventDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Dispatched when a display object is added to the display list. The
- following methods trigger this event: <codeph class="+ topic/ph pr-d/codeph ">DisplayObjectContainer.addChild()</codeph>,
- <codeph class="+ topic/ph pr-d/codeph ">DisplayObjectContainer.addChildAt()</codeph>.
- </apiDesc></adobeApiEventDetail><related-links class="- topic/related-links "><link href="flash.display.xml#DisplayObjectContainer/addChild()" class="- topic/link "><linktext class="- topic/linktext ">flash.display.DisplayObjectContainer.addChild()</linktext></link><link href="flash.display.xml#DisplayObjectContainer/addChildAt()" class="- topic/link "><linktext class="- topic/linktext ">flash.display.DisplayObjectContainer.addChildAt()</linktext></link></related-links></adobeApiEvent><apiOperation id="flash.display:DisplayObject:getBounds" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">getBounds</apiName><shortdesc class="- topic/shortdesc ">
- Returns a rectangle that defines the area of the display object relative to the coordinate system
- of the targetCoordinateSpace object.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The rectangle that defines the area of the display object relative to
- the <codeph class="+ topic/ph pr-d/codeph ">targetCoordinateSpace</codeph> object's coordinate system.
-
- </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.geom:Rectangle</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">targetCoordinateSpace</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.display:DisplayObject</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The display object that defines the coordinate system to use.
-
- </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Returns a rectangle that defines the area of the display object relative to the coordinate system
- of the <codeph class="+ topic/ph pr-d/codeph ">targetCoordinateSpace</codeph> object.
- Consider the following code, which shows how the rectangle returned can vary depending on the
- <codeph class="+ topic/ph pr-d/codeph ">targetCoordinateSpace</codeph> parameter that you pass to the method:
-
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- var container:Sprite = new Sprite();
- container.x = 100;
- container.y = 100;
- this.addChild(container);
- var contents:Shape = new Shape();
- contents.graphics.drawCircle(0,0,100);
- container.addChild(contents);
- trace(contents.getBounds(container));
- // (x=-100, y=-100, w=200, h=200)
- trace(contents.getBounds(this));
- // (x=0, y=0, w=200, h=200)
- </codeblock>
-
-
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> Use the <codeph class="+ topic/ph pr-d/codeph ">localToGlobal()</codeph> and
- <codeph class="+ topic/ph pr-d/codeph ">globalToLocal()</codeph> methods to convert the display object's local coordinates
- to display coordinates, or display coordinates to local coordinates, respectively.</p>
-
- <p class="- topic/p ">The <codeph class="+ topic/ph pr-d/codeph ">getBounds()</codeph> method is similar to the <codeph class="+ topic/ph pr-d/codeph ">getRect()</codeph> method;
- however, the Rectangle returned by the <codeph class="+ topic/ph pr-d/codeph ">getBounds()</codeph> method includes any strokes
- on shapes, whereas the Rectangle returned by the <codeph class="+ topic/ph pr-d/codeph ">getRect()</codeph> method does not.
- For an example, see the description of the <codeph class="+ topic/ph pr-d/codeph ">getRect()</codeph> method.</p>
-
- </apiDesc></apiOperationDetail><related-links class="- topic/related-links "><link href="flash.display.xml#DisplayObject/getRect()" class="- topic/link "><linktext class="- topic/linktext ">getRect()</linktext></link><link href="flash.display.xml#DisplayObject/globalToLocal()" class="- topic/link "><linktext class="- topic/linktext ">globalToLocal()</linktext></link><link href="flash.display.xml#DisplayObject/localToGlobal()" class="- topic/link "><linktext class="- topic/linktext ">localToGlobal()</linktext></link></related-links></apiOperation><apiOperation id="flash.display:DisplayObject:getRect" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">getRect</apiName><shortdesc class="- topic/shortdesc ">
- 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.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The rectangle that defines the area of the display object relative to
- the <codeph class="+ topic/ph pr-d/codeph ">targetCoordinateSpace</codeph> object's coordinate system.
-
- </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.geom:Rectangle</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">targetCoordinateSpace</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.display:DisplayObject</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The display object that defines the coordinate system to use.
-
- </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Returns a rectangle that defines the boundary of the display object,
- based on the coordinate system defined by the <codeph class="+ topic/ph pr-d/codeph ">targetCoordinateSpace</codeph>
- parameter, excluding any strokes on shapes. The values that the <codeph class="+ topic/ph pr-d/codeph ">getRect()</codeph> method
- returns are the same or smaller than those returned by the <codeph class="+ topic/ph pr-d/codeph ">getBounds()</codeph> method.
-
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> Use <codeph class="+ topic/ph pr-d/codeph ">localToGlobal()</codeph> and <codeph class="+ topic/ph pr-d/codeph ">globalToLocal()</codeph> methods
- to convert the display object's local coordinates to Stage coordinates, or Stage coordinates to
- local coordinates, respectively.</p>
-
- </apiDesc><example conref="examples\DisplayObject.getRect.1.as" class="- topic/example "> The following example shows how the <codeph class="+ topic/ph pr-d/codeph ">getBounds()</codeph> method can return a larger
- rectangle than the <codeph class="+ topic/ph pr-d/codeph ">getRect()</codeph> method does, because of the additional area taken up by
- strokes. In this case, the <codeph class="+ topic/ph pr-d/codeph ">triangle</codeph> sprite includes extra strokes because of the
- <codeph class="+ topic/ph pr-d/codeph ">width</codeph> and <codeph class="+ topic/ph pr-d/codeph ">jointStyle</codeph> parameters of the <codeph class="+ topic/ph pr-d/codeph ">lineStyle()</codeph>
- method. The <codeph class="+ topic/ph pr-d/codeph ">trace()</codeph> output (in the last two lines) shows the differences between
- the <codeph class="+ topic/ph pr-d/codeph ">getRect()</codeph> and <codeph class="+ topic/ph pr-d/codeph ">getBounds()</codeph> rectangles:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.display.CapsStyle;
- import flash.display.JointStyle;
- import flash.display.LineScaleMode;
- import flash.display.Sprite;
- import flash.geom.Rectangle;
- var triangle:Sprite = new Sprite();
- var color:uint = 0xFF0044;
- var width:Number = 20;
- var alpha:Number = 1.0;
- var pixelHinting:Boolean = true;
- var scaleMode:String = LineScaleMode.NORMAL;
- var caps:String = CapsStyle.SQUARE;
- var joints:String = JointStyle.MITER;
- triangle.graphics.lineStyle(width, color, alpha, pixelHinting, scaleMode, caps, joints);
- var triangleSide:Number = 100;
- triangle.graphics.moveTo(0, 0);
- triangle.graphics.lineTo(0, triangleSide);
- triangle.graphics.lineTo(triangleSide, triangleSide);
- triangle.graphics.lineTo(0, 0);
- addChild(triangle);
- trace(triangle.getBounds(this)); // (x=-10, y=-24.1, w=134.10000000000002, h=134.1)
- trace(triangle.getRect(this)); // (x=0, y=0, w=100, h=100)
- </codeblock></example></apiOperationDetail><related-links class="- topic/related-links "><link href="flash.display.xml#DisplayObject/getBounds()" class="- topic/link "><linktext class="- topic/linktext ">getBounds()</linktext></link></related-links></apiOperation><apiOperation id="flash.display:DisplayObject:globalToLocal3D" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">globalToLocal3D</apiName><shortdesc class="- topic/shortdesc ">
- Converts a two-dimensional point from the Stage (global) coordinates to a
- three-dimensional display object's (local) coordinates.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">A Vector3D object with coordinates relative to the three-dimensional
- display object.
-
- </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.geom:Vector3D</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">point</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.geom:Point</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">A two dimensional Point object representing global x and y coordinates.
-
- </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Converts a two-dimensional point from the Stage (global) coordinates to a
- three-dimensional display object's (local) coordinates.
-
- <p class="- topic/p ">To use this method, first create an instance of the Point class.
- The x and y values that you assign to the Point object represent global
- coordinates because they are relative to the origin (0,0) of the main display area.
- Then pass the Point object to the <codeph class="+ topic/ph pr-d/codeph ">globalToLocal3D()</codeph>
- method as the <codeph class="+ topic/ph pr-d/codeph ">point</codeph> parameter. The method returns three-dimensional
- coordinates as a Vector3D object containing <codeph class="+ topic/ph pr-d/codeph ">x</codeph>, <codeph class="+ topic/ph pr-d/codeph ">y</codeph>, and
- <codeph class="+ topic/ph pr-d/codeph ">z</codeph> values that are relative to the origin
- of the three-dimensional display object.</p>
-
- </apiDesc></apiOperationDetail></apiOperation><apiOperation id="flash.display:DisplayObject:globalToLocal" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">globalToLocal</apiName><shortdesc class="- topic/shortdesc ">
- Converts the point object from the Stage (global) coordinates
- to the display object's (local) coordinates.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">A Point object with coordinates relative to the display object.
-
- </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.geom:Point</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">point</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.geom:Point</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">An object created with the Point class. The Point object
- specifies the <i class="+ topic/ph hi-d/i ">x</i> and <i class="+ topic/ph hi-d/i ">y</i> coordinates as properties.
-
- </apiDesc></apiParam><apiTipTexts><apiTipText class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiTipText ">Converts the <codeph class="+ topic/ph pr-d/codeph ">point</codeph> object from Stage (global) coordinates to the display
- object's (local) coordinates.
-
- </apiTipText></apiTipTexts></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Converts the <codeph class="+ topic/ph pr-d/codeph ">point</codeph> object from the Stage (global) coordinates
- to the display object's (local) coordinates.
-
- <p class="- topic/p ">To use this method, first create an instance of the Point class. The
- <i class="+ topic/ph hi-d/i ">x</i> and <i class="+ topic/ph hi-d/i ">y</i> values that you assign represent global coordinates because they
- relate to the origin (0,0) of the main display area. Then pass the Point instance
- as the parameter to the <codeph class="+ topic/ph pr-d/codeph ">globalToLocal()</codeph> method. The method returns a new Point object with
- <i class="+ topic/ph hi-d/i ">x</i> and <i class="+ topic/ph hi-d/i ">y</i> values that relate to the origin of the display object
- instead of the origin of the Stage.</p>
-
- </apiDesc><example conref="examples\DisplayObject.hitTestPoint.1.as" class="- topic/example "> The following code creates a Shape object and shows the
- result of calling the <codeph class="+ topic/ph pr-d/codeph ">hitTestPoint()</codeph> method, using different
- points as parameters. The <codeph class="+ topic/ph pr-d/codeph ">globalToLocal()</codeph> method converts the
- point from Stage coordinates to the coordinate space of the shape:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.display.Shape;
- import flash.geom.Point;
- var circle:Shape = new Shape();
- circle.graphics.beginFill(0x0000FF);
- circle.graphics.drawCircle(40, 40, 40);
- circle.x = 10;
- addChild(circle);
- var point1:Point = new Point(0, 0);
- trace(circle.hitTestPoint(point1.x, point1.y, true)); // false
- trace(circle.hitTestPoint(point1.x, point1.y, false)); // false
- trace(circle.globalToLocal(point1)); // [x=-10, y=0]
- var point2:Point = new Point(10, 1);
- trace(circle.hitTestPoint(point2.x, point2.y, true)); // false
- trace(circle.hitTestPoint(point2.x, point2.y, false)); // true
- trace(circle.globalToLocal(point2)); // [x=0, y=1]
- var point3:Point = new Point(30, 20);
- trace(circle.hitTestPoint(point3.x, point3.y, true)); // true
- trace(circle.hitTestPoint(point3.x, point3.y, false)); // true
- trace(circle.globalToLocal(point3)); // [x=20, y=20]
- </codeblock></example></apiOperationDetail><related-links class="- topic/related-links "><link href="flash.display.xml#DisplayObject/localToGlobal()" class="- topic/link "><linktext class="- topic/linktext ">localToGlobal()</linktext></link><link href="flash.geom.xml#Point" class="- topic/link "><linktext class="- topic/linktext ">flash.geom.Point class</linktext></link></related-links></apiOperation><apiOperation id="flash.display:DisplayObject:hitTestObject" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">hitTestObject</apiName><shortdesc class="- topic/shortdesc ">
- Evaluates the bounding box of the display object to see if it overlaps or intersects with the
- bounding box of the obj display object.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc "><codeph class="+ topic/ph pr-d/codeph ">true</codeph> if the bounding boxes of the display objects intersect; <codeph class="+ topic/ph pr-d/codeph ">false</codeph> if not.
-
-
- </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Boolean</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">obj</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.display:DisplayObject</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The display object to test against.
-
- </apiDesc></apiParam><apiTipTexts><apiTipText class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiTipText ">Evaluates the bounding box of the display object to see if it overlaps or intersects with the
- bounding box of the display object passed as a parameter.
-
- </apiTipText></apiTipTexts></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Evaluates the bounding box of the display object to see if it overlaps or intersects with the
- bounding box of the <codeph class="+ topic/ph pr-d/codeph ">obj</codeph> display object.
-
- </apiDesc><example conref="examples\DisplayObject.hitTestObject.1.as" class="- topic/example "> The following code creates three Shape objects and shows the
- result of calling the <codeph class="+ topic/ph pr-d/codeph ">hitTestObject()</codeph> method. Note that although
- circle2 and circle3 do not overlap, their bounding boxes do. Thus, the hit test
- of circle2 and circle3 returns <codeph class="+ topic/ph pr-d/codeph ">true</codeph>.
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.display.Shape;
- var circle1:Shape = new Shape();
- circle1.graphics.beginFill(0x0000FF);
- circle1.graphics.drawCircle(40, 40, 40);
- addChild(circle1);
- var circle2:Shape = new Shape();
- circle2.graphics.beginFill(0x00FF00);
- circle2.graphics.drawCircle(40, 40, 40);
- circle2.x = 50;
- addChild(circle2);
- var circle3:Shape = new Shape();
- circle3.graphics.beginFill(0xFF0000);
- circle3.graphics.drawCircle(40, 40, 40);
- circle3.x = 100;
- circle3.y = 67;
- addChild(circle3);
- trace(circle1.hitTestObject(circle2)); // true
- trace(circle1.hitTestObject(circle3)); // false
- trace(circle2.hitTestObject(circle3)); // true
- </codeblock></example></apiOperationDetail></apiOperation><apiOperation id="flash.display:DisplayObject:hitTestPoint" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">hitTestPoint</apiName><shortdesc class="- topic/shortdesc ">
- Evaluates the display object to see if it overlaps or intersects with the
- point specified by the x and y parameters.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc "><codeph class="+ topic/ph pr-d/codeph ">true</codeph> if the display object overlaps or intersects with the specified point;
- <codeph class="+ topic/ph pr-d/codeph ">false</codeph> otherwise.
-
- </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Boolean</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">x</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <i class="+ topic/ph hi-d/i ">x</i> coordinate to test against this object.
-
- </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">y</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Number</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The <i class="+ topic/ph hi-d/i ">y</i> coordinate to test against this object.
-
- </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">shapeFlag</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">Boolean</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">false</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">Whether to check against the actual pixels of the object (<codeph class="+ topic/ph pr-d/codeph ">true</codeph>)
- or the bounding box (<codeph class="+ topic/ph pr-d/codeph ">false</codeph>).
-
- </apiDesc></apiParam><apiTipTexts><apiTipText class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiTipText ">Evaluates the display object to see if it overlaps or intersects with a point specified
- by x and y.
-
- </apiTipText></apiTipTexts></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Evaluates the display object to see if it overlaps or intersects with the
- point specified by the <codeph class="+ topic/ph pr-d/codeph ">x</codeph> and <codeph class="+ topic/ph pr-d/codeph ">y</codeph> parameters.
- The <codeph class="+ topic/ph pr-d/codeph ">x</codeph> and <codeph class="+ topic/ph pr-d/codeph ">y</codeph> parameters specify a point in the
- coordinate space of the Stage, not the display object container that contains the
- display object (unless that display object container is the Stage).
-
- </apiDesc><example conref="examples\DisplayObject.hitTestPoint.1.as" class="- topic/example "> The following code creates a Shape object and shows the
- result of calling the <codeph class="+ topic/ph pr-d/codeph ">hitTestPoint()</codeph> method, using different
- points as parameters. The <codeph class="+ topic/ph pr-d/codeph ">globalToLocal()</codeph> method converts the
- point from Stage coordinates to the coordinate space of the shape:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.display.Shape;
- import flash.geom.Point;
- var circle:Shape = new Shape();
- circle.graphics.beginFill(0x0000FF);
- circle.graphics.drawCircle(40, 40, 40);
- circle.x = 10;
- addChild(circle);
- var point1:Point = new Point(0, 0);
- trace(circle.hitTestPoint(point1.x, point1.y, true)); // false
- trace(circle.hitTestPoint(point1.x, point1.y, false)); // false
- trace(circle.globalToLocal(point1)); // [x=-10, y=0]
- var point2:Point = new Point(10, 1);
- trace(circle.hitTestPoint(point2.x, point2.y, true)); // false
- trace(circle.hitTestPoint(point2.x, point2.y, false)); // true
- trace(circle.globalToLocal(point2)); // [x=0, y=1]
- var point3:Point = new Point(30, 20);
- trace(circle.hitTestPoint(point3.x, point3.y, true)); // true
- trace(circle.hitTestPoint(point3.x, point3.y, false)); // true
- trace(circle.globalToLocal(point3)); // [x=20, y=20]
- </codeblock></example></apiOperationDetail><related-links class="- topic/related-links "><link href="flash.display.xml#DisplayObject/opaqueBackground" class="- topic/link "><linktext class="- topic/linktext ">opaqueBackground</linktext></link></related-links></apiOperation><apiOperation id="flash.display:DisplayObject:local3DToGlobal" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">local3DToGlobal</apiName><shortdesc class="- topic/shortdesc ">
- Converts a three-dimensional point of the three-dimensional display
- object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">A two-dimensional point representing a three-dimensional point
- in two-dimensional space.
-
- </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.geom:Point</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">point3d</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.geom:Vector3D</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">A Vector3D object containing either a three-dimensional point or
- the coordinates of the three-dimensional display object.
-
- </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Converts a three-dimensional point of the three-dimensional display
- object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
-
- <p class="- topic/p ">For example, you can only use two-dimensional coordinates (x,y) to
- draw with the <codeph class="+ topic/ph pr-d/codeph ">display.Graphics</codeph> methods. To draw a three-dimensional
- object, you need to map the three-dimensional coordinates of a
- display object to two-dimensional coordinates. First, create an instance of
- the Vector3D class that holds the x-, y-, and z- coordinates of the three-dimensional
- display object. Then pass the Vector3D object to the <codeph class="+ topic/ph pr-d/codeph ">local3DToGlobal()</codeph>
- method as the <codeph class="+ topic/ph pr-d/codeph ">point3d</codeph> parameter. The method returns a two-dimensional Point
- object that can be used
- with the Graphics API to draw the three-dimensional object.</p>
-
-
- </apiDesc><example conref="examples\Local3DToGlobalExample.as" class="- topic/example "> This example draws a simple three-dimensional cube in a two dimensional space
- using <codeph class="+ topic/ph pr-d/codeph ">display.Graphics</codeph> methods. The location of <codeph class="+ topic/ph pr-d/codeph ">this</codeph> display
- object is offset, so the cube's registration point is in its center. A vector
- of Vector3D objects holds the cube's three dimensional coordinates. The top
- of the cube is draw first, the bottom is drawn second, and then the top and bottom
- four corners are connected. You need to add the cube to the display object
- container before drawing the cube in order to use the <codeph class="+ topic/ph pr-d/codeph ">local3DToGlobal()</codeph> method.
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- package {
- import flash.display.MovieClip;
- import flash.display.Sprite;
- import flash.display.Graphics;
- import flash.geom.*;
- public class Local3DToGlobalExample extends MovieClip {
- private var myCube:Sprite = new Sprite();
- private var v8:Vector.<Vector3D> = new Vector.<Vector3D>(8);
- public function Local3DToGlobalExample():void {
- this.x = -(this.stage.stageWidth / 2);
- this.y = -(this.stage.stageWidth / 2);
- v8[0] = new Vector3D(-40,-40,-40);
- v8[1] = new Vector3D(40,-40,-40);
- v8[2] = new Vector3D(40,-40,40);
- v8[3] = new Vector3D(-40,-40,40);
- v8[4] = new Vector3D(-40,100,-40);
- v8[5] = new Vector3D(40,100,-40);
- v8[6] = new Vector3D(40,100,40);
- v8[7] = new Vector3D(-40,100,40);
- myCube.x = (this.stage.stageWidth / 2);
- myCube.y = (this.stage.stageWidth / 2);
- myCube.z = 1;
- addChild(myCube);
- Cube();
- }
- private function Cube():void {
- var ps:Point = new Point(0,0);
- myCube.graphics.lineStyle(2,0xFF0000);
- ps = myCube.local3DToGlobal(v8[0]);
- myCube.graphics.moveTo(ps.x, ps.y);
- ps = myCube.local3DToGlobal(v8[1]);
- myCube.graphics.lineTo(ps.x, ps.y);
- ps = myCube.local3DToGlobal(v8[2]);
- myCube.graphics.lineTo(ps.x, ps.y);
- ps = myCube.local3DToGlobal(v8[3]);
- myCube.graphics.lineTo(ps.x, ps.y);
- ps = myCube.local3DToGlobal(v8[0]);
- myCube.graphics.lineTo(ps.x, ps.y);
- ps = myCube.local3DToGlobal(v8[4]);
- myCube.graphics.moveTo(ps.x, ps.y);
- ps = myCube.local3DToGlobal(v8[5]);
- myCube.graphics.lineTo(ps.x, ps.y);
- ps = myCube.local3DToGlobal(v8[6]);
- myCube.graphics.lineTo(ps.x, ps.y);
- ps = myCube.local3DToGlobal(v8[7]);
- myCube.graphics.lineTo(ps.x, ps.y);
- ps = myCube.local3DToGlobal(v8[4]);
- myCube.graphics.lineTo(ps.x, ps.y);
- ps = myCube.local3DToGlobal(v8[0]);
- myCube.graphics.moveTo(ps.x, ps.y);
- ps = myCube.local3DToGlobal(v8[4]);
- myCube.graphics.lineTo(ps.x, ps.y);
- ps = myCube.local3DToGlobal(v8[1]);
- myCube.graphics.moveTo(ps.x, ps.y);
- ps = myCube.local3DToGlobal(v8[5]);
- myCube.graphics.lineTo(ps.x, ps.y);
- ps = myCube.local3DToGlobal(v8[2]);
- myCube.graphics.moveTo(ps.x, ps.y);
- ps = myCube.local3DToGlobal(v8[6]);
- myCube.graphics.lineTo(ps.x, ps.y);
- ps = myCube.local3DToGlobal(v8[3]);
- myCube.graphics.moveTo(ps.x, ps.y);
- ps = myCube.local3DToGlobal(v8[7]);
- myCube.graphics.lineTo(ps.x, ps.y);
- }
- }
- }
- </codeblock></example></apiOperationDetail></apiOperation><apiOperation id="flash.display:DisplayObject:localToGlobal" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">localToGlobal</apiName><shortdesc class="- topic/shortdesc ">
- Converts the point object from the display object's (local) coordinates to the
- Stage (global) coordinates.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">A Point object with coordinates relative to the Stage.
-
- </apiDesc><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.geom:Point</apiOperationClassifier></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">point</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.geom:Point</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The name or identifier of a point created with the Point class, specifying the
- <i class="+ topic/ph hi-d/i ">x</i> and <i class="+ topic/ph hi-d/i ">y</i> coordinates as properties.
-
- </apiDesc></apiParam></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Converts the <codeph class="+ topic/ph pr-d/codeph ">point</codeph> object from the display object's (local) coordinates to the
- Stage (global) coordinates.
-
- <p class="- topic/p ">This method allows you to convert any given <i class="+ topic/ph hi-d/i ">x</i> and <i class="+ topic/ph hi-d/i ">y</i> coordinates from
- values that are relative to the origin (0,0) of a specific display object (local coordinates)
- to values that are relative to the origin of the Stage (global coordinates).</p>
-
- <p class="- topic/p ">To use this method, first create an instance of the Point class. The
- <i class="+ topic/ph hi-d/i ">x</i> and <i class="+ topic/ph hi-d/i ">y</i> values that you assign represent local coordinates because they
- relate to the origin of the display object.</p>
-
- <p class="- topic/p ">You then pass the Point instance that you created as the parameter to
- the <codeph class="+ topic/ph pr-d/codeph ">localToGlobal()</codeph> method. The method returns a new Point object with
- <i class="+ topic/ph hi-d/i ">x</i> and <i class="+ topic/ph hi-d/i ">y</i> values that relate to the origin of the Stage
- instead of the origin of the display object.</p>
-
- </apiDesc><example conref="examples\DisplayObject.localToGlobal.1.as" class="- topic/example "> The following code creates a Sprite object. The <codeph class="+ topic/ph pr-d/codeph ">mouseX</codeph> and
- <codeph class="+ topic/ph pr-d/codeph ">mouseY</codeph> properties of the sprite are in the coordinate space of the display
- object. This code uses the <codeph class="+ topic/ph pr-d/codeph ">localToGlobal()</codeph> method to translate these
- properties to the global (Stage) coordinates:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.display.Sprite;
- import flash.events.MouseEvent;
- import flash.geom.Point;
- var square:Sprite = new Sprite();
- square.graphics.beginFill(0xFFCC00);
- square.graphics.drawRect(0, 0, 100, 100);
- square.x = 100;
- square.y = 200;
- addChild(square);
- square.addEventListener(MouseEvent.CLICK, traceCoordinates)
- function traceCoordinates(event:MouseEvent):void {
- var clickPoint:Point = new Point(square.mouseX, square.mouseY);
- trace("display object coordinates:", clickPoint);
- trace("stage coordinates:", square.localToGlobal(clickPoint));
- }
- </codeblock></example></apiOperationDetail><related-links class="- topic/related-links "><link href="flash.display.xml#DisplayObject/globalToLocal()" class="- topic/link "><linktext class="- topic/linktext ">globalToLocal()</linktext></link><link href="flash.geom.xml#Point" class="- topic/link "><linktext class="- topic/linktext ">flash.geom.Point class</linktext></link></related-links></apiOperation><apiValue id="flash.display:DisplayObject:accessibilityProperties:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">accessibilityProperties</apiName><shortdesc class="- topic/shortdesc ">
- The current accessibility options for this display object.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.accessibility:AccessibilityProperties</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- The current accessibility options for this display object. If you modify the <codeph class="+ topic/ph pr-d/codeph ">accessibilityProperties</codeph>
- property or any of the fields within <codeph class="+ topic/ph pr-d/codeph ">accessibilityProperties</codeph>, you must call
- the <codeph class="+ topic/ph pr-d/codeph ">Accessibility.updateProperties()</codeph> method to make your changes take effect.
-
- <p class="flashonly"><b class="+ topic/ph hi-d/b ">Note</b>: For an object created in the Flash authoring environment, the value of <codeph class="+ topic/ph pr-d/codeph ">accessibilityProperties</codeph>
- is prepopulated with any information you entered in the Accessibility panel for
- that object.</p>
-
- </apiDesc><example conref="examples\DisplayObject.accessibilityProperties.1.as" class="- topic/example "> The following example shows how the to attach a simple AccessibilityProperties
- object to a TextField instance:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.text.TextField;
- import flash.accessibility.AccessibilityProperties;
- import flash.accessibility.Accessibility;
- import flash.system.Capabilities;
- var tf:TextField = new TextField();
- tf.text = "hello";
- var accessProps:AccessibilityProperties = new AccessibilityProperties();
- accessProps.name = "Greeting";
- tf.accessibilityProperties = accessProps;
- if (Capabilities.hasAccessibility) {
- Accessibility.updateProperties();
- }
- trace(tf.accessibilityProperties.name); // Greeting
- </codeblock></example></apiValueDetail><related-links class="- topic/related-links "><link href="flash.accessibility.xml#Accessibility/updateProperties()" class="- topic/link "><linktext class="- topic/linktext ">flash.accessibility.Accessibility.updateProperties()</linktext></link><link href="flash.accessibility.xml#AccessibilityProperties" class="- topic/link "><linktext class="- topic/linktext ">flash.accessibility.AccessibilityProperties</linktext></link></related-links></apiValue><apiValue id="flash.display:DisplayObject:alpha:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">alpha</apiName><shortdesc class="- topic/shortdesc ">
- Indicates the alpha transparency value of the object specified.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Indicates the alpha transparency value of the object specified.
- Valid values are 0 (fully transparent) to 1 (fully opaque).
- The default value is 1. Display objects with <codeph class="+ topic/ph pr-d/codeph ">alpha</codeph>
- set to 0 <i class="+ topic/ph hi-d/i ">are</i> active, even though they are invisible.
-
- </apiDesc><example conref="examples\DisplayObject.alpha.1.as" class="- topic/example "> The following code sets the <codeph class="+ topic/ph pr-d/codeph ">alpha</codeph> property of a sprite
- to 50% when the mouse rolls over the sprite:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.display.Sprite;
- import flash.events.MouseEvent;
- var circle:Sprite = new Sprite();
- circle.graphics.beginFill(0xFF0000);
- circle.graphics.drawCircle(40, 40, 40);
- addChild(circle);
- circle.addEventListener(MouseEvent.MOUSE_OVER, dimObject);
- circle.addEventListener(MouseEvent.MOUSE_OUT, restoreObject);
- function dimObject(event:MouseEvent):void {
- event.target.alpha = 0.5;
- }
- function restoreObject(event:MouseEvent):void {
- event.target.alpha = 1.0;
- }
- </codeblock></example></apiValueDetail></apiValue><apiValue id="flash.display:DisplayObject:blendMode:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">blendMode</apiName><shortdesc class="- topic/shortdesc ">
- A value from the BlendMode class that specifies which blend mode to use.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- A value from the BlendMode class that specifies which blend mode to use.
- A bitmap can be drawn internally in two ways. If you have a blend mode enabled or an
- external clipping mask, the bitmap is drawn by adding a bitmap-filled square shape to the vector
- render. If you attempt to set this property to an invalid value, Flash runtimes set the value
- to <codeph class="+ topic/ph pr-d/codeph ">BlendMode.NORMAL</codeph>.
-
- <p class="- topic/p ">The <codeph class="+ topic/ph pr-d/codeph ">blendMode</codeph> property affects each pixel of the display object.
- Each pixel is composed of three constituent
- colors (red, green, and blue), and each constituent color has a value between 0x00 and 0xFF.
- Flash Player or Adobe AIR compares each constituent color of one pixel in the movie clip with
- the corresponding color of the pixel in the background. For example, if <codeph class="+ topic/ph pr-d/codeph ">blendMode</codeph>
- is set to <codeph class="+ topic/ph pr-d/codeph ">BlendMode.LIGHTEN</codeph>, Flash Player or Adobe AIR compares the red value of the display object with
- the red value of the background, and uses the lighter of the two as the
- value for the red component of the displayed color.</p>
-
- <p class="- topic/p ">The following table describes the <codeph class="+ topic/ph pr-d/codeph ">blendMode</codeph> settings.
- The BlendMode class defines string values you can use.
- The illustrations in the table show <codeph class="+ topic/ph pr-d/codeph ">blendMode</codeph> values applied to a circular
- display object (2) superimposed on another display object (1).</p>
-
-
- <p class="- topic/p ">
- <adobeimage alt="Square Number 1" href="../../images/blendMode-0a.jpg" placement="inline" class="+ topic/image adobe-d/adobeimage "/>
-
- <adobeimage alt="Circle Number 2" href="../../images/blendMode-0b.jpg" placement="inline" class="+ topic/image adobe-d/adobeimage "/>
-
- </p>
-
-
- <adobetable class="innertable"><tgroup cols="3" class="- topic/tgroup "><thead class="- topic/thead "><row class="- topic/row "><entry class="- topic/entry ">BlendMode Constant</entry><entry class="- topic/entry ">Illustration</entry><entry class="- topic/entry ">Description</entry></row></thead><tbody class="- topic/tbody "><row valign="top" class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">BlendMode.NORMAL</codeph></entry><entry class="- topic/entry "><adobeimage alt="blend mode NORMAL" href="../../images/blendMode-1.jpg" placement="inline" class="+ topic/image adobe-d/adobeimage "/></entry><entry class="- topic/entry ">The display object appears in front of the background. Pixel values of the display object
- override those of the background. Where the display object is transparent, the background is
- visible.</entry></row><row valign="top" class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">BlendMode.LAYER</codeph></entry><entry class="- topic/entry "><adobeimage alt="blend mode LAYER" href="../../images/blendMode-2.jpg" placement="inline" class="+ topic/image adobe-d/adobeimage "/></entry><entry class="- topic/entry ">Forces the creation of a transparency group for the display object. This means that the display
- object is pre-composed in a temporary buffer before it is processed further. This is done
- automatically if the display object is pre-cached using bitmap caching or if the display object is
- a display object container with at least one child object with a <codeph class="+ topic/ph pr-d/codeph ">blendMode</codeph>
- setting other than <codeph class="+ topic/ph pr-d/codeph ">BlendMode.NORMAL</codeph>. Not supported under GPU rendering.
- </entry></row><row valign="top" class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">BlendMode.MULTIPLY</codeph></entry><entry class="- topic/entry "><adobeimage alt="blend mode MULTIPLY" href="../../images/blendMode-3.jpg" placement="inline" class="+ topic/image adobe-d/adobeimage "/></entry><entry class="- topic/entry ">Multiplies the values of the display object constituent colors by the colors of the background color,
- and then normalizes by dividing by 0xFF,
- resulting in darker colors. This setting is commonly used for shadows and depth effects.
-
- <p class="- topic/p ">For example, if a constituent color (such as red) of one pixel in the display object and the
- corresponding color of the pixel in the background both have the value 0x88, the multiplied
- result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color,
- which is a darker shade than the color of the display object or the color of the background.</p></entry></row><row valign="top" class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">BlendMode.SCREEN</codeph></entry><entry class="- topic/entry "><adobeimage alt="blend mode SCREEN" href="../../images/blendMode-4.jpg" placement="inline" class="+ topic/image adobe-d/adobeimage "/></entry><entry class="- topic/entry ">Multiplies the complement (inverse) of the display object color by the complement of the background
- color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black
- areas of the display object.</entry></row><row valign="top" class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">BlendMode.LIGHTEN</codeph></entry><entry class="- topic/entry "><adobeimage alt="blend mode LIGHTEN" href="../../images/blendMode-5.jpg" placement="inline" class="+ topic/image adobe-d/adobeimage "/></entry><entry class="- topic/entry ">Selects the lighter of the constituent colors of the display object and the color of the background (the
- colors with the larger values). This setting is commonly used for superimposing type.
-
- <p class="- topic/p ">For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background
- pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is
- 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.</p></entry></row><row valign="top" class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">BlendMode.DARKEN</codeph></entry><entry class="- topic/entry "><adobeimage alt="blend mode DARKEN" href="../../images/blendMode-6.jpg" placement="inline" class="+ topic/image adobe-d/adobeimage "/></entry><entry class="- topic/entry ">Selects the darker of the constituent colors of the display object and the colors of the
- background (the colors with the smaller values). This setting is commonly used for superimposing type.
-
- <p class="- topic/p ">For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background
- pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is
- 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.</p></entry></row><row valign="top" class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">BlendMode.DIFFERENCE</codeph></entry><entry class="- topic/entry "><adobeimage alt="blend mode DIFFERENCE" href="../../images/blendMode-7.jpg" placement="inline" class="+ topic/image adobe-d/adobeimage "/></entry><entry class="- topic/entry ">Compares the constituent colors of the display object with the colors of its background, and subtracts
- the darker of the values of the two constituent colors from the lighter value. This setting is commonly
- used for more vibrant colors.
-
- <p class="- topic/p ">For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background
- pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is
- 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).</p></entry></row><row valign="top" class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">BlendMode.ADD</codeph></entry><entry class="- topic/entry "><adobeimage alt="blend mode ADD" href="../../images/blendMode-8.jpg" placement="inline" class="+ topic/image adobe-d/adobeimage "/></entry><entry class="- topic/entry ">Adds the values of the constituent colors of the display object to the colors of its background, applying a
- ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between
- two objects.
-
- <p class="- topic/p ">For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background
- pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is
- 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).</p></entry></row><row valign="top" class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">BlendMode.SUBTRACT</codeph></entry><entry class="- topic/entry "><adobeimage alt="blend mode SUBTRACT" href="../../images/blendMode-9.jpg" placement="inline" class="+ topic/image adobe-d/adobeimage "/></entry><entry class="- topic/entry ">Subtracts the values of the constituent colors in the display object from the values of the
- background color, applying a floor of 0. This setting is commonly used for animating a
- darkening dissolve between two objects.
-
- <p class="- topic/p ">For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background
- pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is
- 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).</p></entry></row><row valign="top" class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">BlendMode.INVERT</codeph></entry><entry class="- topic/entry "><adobeimage alt="blend mode INVERT" href="../../images/blendMode-10.jpg" placement="inline" class="+ topic/image adobe-d/adobeimage "/></entry><entry class="- topic/entry ">Inverts the background.</entry></row><row valign="top" class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">BlendMode.ALPHA</codeph></entry><entry class="- topic/entry "><adobeimage alt="blend mode ALPHA" href="../../images/blendMode-11.jpg" placement="inline" class="+ topic/image adobe-d/adobeimage "/></entry><entry class="- topic/entry ">Applies the alpha value of each pixel of the display object to the background.
- This requires the <codeph class="+ topic/ph pr-d/codeph ">blendMode</codeph> setting of the parent display object to be set to
- <codeph class="+ topic/ph pr-d/codeph ">BlendMode.LAYER</codeph>.
- For example, in the illustration, the parent display object, which is a white background,
- has <codeph class="+ topic/ph pr-d/codeph ">blendMode = BlendMode.LAYER</codeph>. Not supported under GPU rendering.</entry></row><row valign="top" class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">BlendMode.ERASE</codeph></entry><entry class="- topic/entry "><adobeimage alt="blend mode ERASE" href="../../images/blendMode-12.jpg" placement="inline" class="+ topic/image adobe-d/adobeimage "/></entry><entry class="- topic/entry ">Erases the background based on the alpha value of the display object. This requires the
- <codeph class="+ topic/ph pr-d/codeph ">blendMode</codeph> of the parent display object to be set to
- <codeph class="+ topic/ph pr-d/codeph ">BlendMode.LAYER</codeph>. For example, in the
- illustration, the parent display object, which is a white background, has
- <codeph class="+ topic/ph pr-d/codeph ">blendMode = BlendMode.LAYER</codeph>. Not supported under GPU rendering.</entry></row><row valign="top" class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">BlendMode.OVERLAY</codeph></entry><entry class="- topic/entry "><adobeimage alt="blend mode OVERLAY" href="../../images/blendMode-13.jpg" placement="inline" class="+ topic/image adobe-d/adobeimage "/></entry><entry class="- topic/entry ">Adjusts the color of each pixel based on the darkness of the background.
- If the background is lighter than 50% gray, the display object and background colors are
- screened, which results in a lighter color. If the background is darker than 50% gray,
- the colors are multiplied, which results in a darker color.
- This setting is commonly used for shading effects. Not supported under GPU rendering.</entry></row><row valign="top" class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">BlendMode.HARDLIGHT</codeph></entry><entry class="- topic/entry "><adobeimage alt="blend mode HARDLIGHT" href="../../images/blendMode-14.jpg" placement="inline" class="+ topic/image adobe-d/adobeimage "/></entry><entry class="- topic/entry ">Adjusts the color of each pixel based on the darkness of the display object.
- If the display object is lighter than 50% gray, the display object and background colors are
- screened, which results in a lighter color. If the display object is darker than 50% gray,
- the colors are multiplied, which results in a darker color.
- This setting is commonly used for shading effects. Not supported under GPU rendering.</entry></row><row valign="top" class="- topic/row "><entry class="- topic/entry "><codeph class="+ topic/ph pr-d/codeph ">BlendMode.SHADER</codeph></entry><entry align="center" valign="middle" class="- topic/entry ">N/A</entry><entry class="- topic/entry ">Adjusts the color using a custom shader routine. The shader that is used is specified
- as the Shader instance assigned to the <codeph class="+ topic/ph pr-d/codeph ">blendShader</codeph> property. Setting the
- <codeph class="+ topic/ph pr-d/codeph ">blendShader</codeph> property of a display object to a Shader instance
- automatically sets the display object's <codeph class="+ topic/ph pr-d/codeph ">blendMode</codeph> property to
- <codeph class="+ topic/ph pr-d/codeph ">BlendMode.SHADER</codeph>. If the <codeph class="+ topic/ph pr-d/codeph ">blendMode</codeph> property is set to
- <codeph class="+ topic/ph pr-d/codeph ">BlendMode.SHADER</codeph> without first setting the <codeph class="+ topic/ph pr-d/codeph ">blendShader</codeph> property,
- the <codeph class="+ topic/ph pr-d/codeph ">blendMode</codeph> property is set to <codeph class="+ topic/ph pr-d/codeph ">BlendMode.NORMAL</codeph>. Not supported under GPU rendering.</entry></row></tbody></tgroup></adobetable>
-
- </apiDesc><example conref="examples\DisplayObject.blendMode.1.as" class="- topic/example "> The following code creates two sprite objects, a square and a circle,
- and sets the blend mode of the circle (in the foreground) to <codeph class="+ topic/ph pr-d/codeph ">BlendMode.SUBTRACT</codeph>
- when the pointer rolls over the circle:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.display.Sprite;
- import flash.display.BlendMode;
- import flash.events.MouseEvent;
- var square:Sprite = new Sprite();
- square.graphics.beginFill(0xFF88CC);
- square.graphics.drawRect(0, 0, 80, 80);
- addChild(square);
- var circle:Sprite = new Sprite();
- circle.graphics.beginFill(0xAA0022);
- circle.graphics.drawCircle(40, 40, 40);
- addChild(circle);
- circle.addEventListener(MouseEvent.MOUSE_OVER, dimObject);
- circle.addEventListener(MouseEvent.MOUSE_OUT, restoreObject);
- function dimObject(event:MouseEvent):void {
- event.target.blendMode = BlendMode.SUBTRACT;
- }
- function restoreObject(event:MouseEvent):void {
- event.target.blendMode = BlendMode.NORMAL;
- }
- </codeblock></example></apiValueDetail><related-links class="- topic/related-links "><link href="flash.display.xml#BlendMode" class="- topic/link "><linktext class="- topic/linktext ">flash.display.BlendMode</linktext></link><link href="flash.display.xml#DisplayObject/blendShader" class="- topic/link "><linktext class="- topic/linktext ">blendShader</linktext></link></related-links></apiValue><apiValue id="flash.display:DisplayObject:cacheAsBitmapMatrix:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">cacheAsBitmapMatrix</apiName><shortdesc class="- topic/shortdesc ">
- If non-null, this Matrix object defines how a display object is rendered when
- cacheAsBitmap is set to true.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="AIR" version="2.0" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.geom:Matrix</apiValueClassifier><apiTipTexts><apiTipText class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiTipText ">The transformation matrix used when rendering a cached version of
- this display object's bitmap.
- </apiTipText></apiTipTexts></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- If non-null, this Matrix object defines how a display object is rendered when
- <codeph class="+ topic/ph pr-d/codeph ">cacheAsBitmap</codeph> is set to <codeph class="+ topic/ph pr-d/codeph ">true</codeph>. The application uses
- this matrix as a transformation matrix that is applied when rendering the bitmap version of
- the display object.
-
- <p class="- topic/p "><i class="+ topic/ph hi-d/i ">AIR profile support:</i> This feature is supported
- on mobile devices, but it is not supported on desktop operating systems. It also has
- limited support on AIR for TV devices.
- Specifically, on AIR for TV devices, supported transformations include scaling and translation,
- but not rotation and skewing. See
- <xref href="http://help.adobe.com/en_US/air/build/WS144092a96ffef7cc16ddeea2126bb46b82f-8000.html" class="- topic/xref ">
- AIR Profile Support</xref> for more information regarding API support across multiple profiles.</p>
-
- <p class="- topic/p ">With <codeph class="+ topic/ph pr-d/codeph ">cacheAsBitmapMatrix</codeph> set, the application retains a cached
- bitmap image across various 2D transformations, including translation, rotation,
- and scaling. If the application uses hardware acceleration, the object will
- be stored in video memory as a texture. This allows the GPU to apply
- the supported transformations to the object. The GPU
- can perform these transformations faster than the CPU.</p>
-
-
- <p class="- topic/p ">To use the hardware acceleration, set Rendering to GPU in
- the General tab of the iPhone Settings dialog box in Flash Professional CS5.
- Or set the <codeph class="+ topic/ph pr-d/codeph ">renderMode</codeph> property to <codeph class="+ topic/ph pr-d/codeph ">gpu</codeph> in the
- application descriptor file. Note that AIR for TV devices automatically
- use hardware acceleration if it is available.</p>
-
- <p class="- topic/p ">For example, the following code sends an untransformed bitmap representation
- of the display object to the GPU:</p>
-
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">matrix:Matrix = new Matrix(); // creates an identity matrix
- mySprite.cacheAsBitmapMatrix = matrix;
- mySprite.cacheAsBitmap = true;</codeblock>
-
- <p class="- topic/p ">Usually, the identity matrix (<codeph class="+ topic/ph pr-d/codeph ">new Matrix()</codeph>) suffices. However,
- you can use another matrix, such as a scaled-down matrix, to upload
- a different bitmap to the GPU. For example, the following example applies
- a <codeph class="+ topic/ph pr-d/codeph ">cacheAsBitmapMatrix</codeph> matrix that is scaled by 0.5 on the x and y axes.
- The bitmap object that the GPU uses is smaller, however the GPU adjusts
- its size to match the transform.matrix property of the display object:</p>
-
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">matrix:Matrix = new Matrix(); // creates an identity matrix
- matrix.scale(0.5, 0.5); // scales the matrix
- mySprite.cacheAsBitmapMatrix = matrix;
- mySprite.cacheAsBitmap = true;</codeblock>
-
- <p class="- topic/p ">Generally, you should choose to use a matrix that transforms the display object
- to the size that it will appear in the application. For example, if
- your application displays the bitmap version of the sprite scaled down by a half,
- use a matrix that scales down by a half. If you application will display
- the sprite larger than its current dimensions, use a matrix that
- scales up by that factor.</p>
-
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> The <codeph class="+ topic/ph pr-d/codeph ">cacheAsBitmapMatrix</codeph> property
- is suitable for 2D transformations. If you need to apply transformations in 3D,
- you may do so by setting a 3D property of the object and manipulating its
- <codeph class="+ topic/ph pr-d/codeph ">transform.matrix3D</codeph> property. If the application is packaged
- using GPU mode, this allows the 3D transforms to be applied to
- the object by the GPU. The <codeph class="+ topic/ph pr-d/codeph ">cacheAsBitmapMatrix</codeph> is ignored
- for 3D objects.</p>
-
- </apiDesc><example conref="examples\DisplayObject.cacheAsBitmapMatrix.as" class="- topic/example "> The following example applies uses the <codeph class="+ topic/ph pr-d/codeph ">cacheAsBitmapMatrix</codeph> property to apply transformations
- to a bitmap version of the movie clip <codeph class="+ topic/ph pr-d/codeph ">my_shape</codeph>.
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.geom.Matrix;
- import flash.display.*;
- import flash.utils.Timer;
- var my_shape:MovieClip = new MovieClip();
- my_shape.graphics.beginFill(0xCCFF00);
- my_shape.graphics.drawRect(200, 0, 100, 100);
- addChild(my_shape);
- var my_timer:Timer = new Timer(250);
- my_timer.start();
- my_timer.addEventListener(TimerEvent.TIMER, timerHandler);
- // make sure this Display Object remains cached for all 2D transforms
- my_shape.cacheAsBitmap = true;
- my_shape.cacheAsBitmapMatrix = new Matrix();
- // rotation variables
- const initAngle:Number = 0;
- const pi:Number = 3.142;
- const incrAngle:Number = pi/10;
- // scaling variables
- const initScale:Number = 0.25;
- const incrScale: Number = 1.1;
- var initHeight : Number = my_shape.height;
- var initWidth : Number = my_shape.width;
- // translation variables
- var incrX : Number = root.width / 20;
- var incrY : Number = root.height / 10;
- // do some initial transforms
- var tempMat : Matrix = my_shape.transform.matrix;
- tempMat.rotate(initAngle);
- tempMat.scale(initScale, initScale);
- my_shape.transform.matrix = tempMat;
- function timerHandler(evt:TimerEvent):void {
- tempMat = my_shape.transform.matrix;
-
- tempMat.rotate(incrAngle);
- tempMat.translate(incrX, incrY);
- tempMat.scale(incrScale, incrScale);
-
- my_shape.transform.matrix = tempMat;
-
- // ensure we are still in a reasonable state or reset
- if(my_shape.height > stage.stageHeight/2)
- {
- my_shape.height = initHeight;
- }
-
- if(my_shape.width > stage.stageWidth/2)
- {
- my_shape.width = initWidth;
- }
-
- if(my_shape.x > stage.stageWidth)
- {
- my_shape.x = 0;
- }
- else if (my_shape.x < 0)
- {
- my_shape.x = stage.stageWidth;
- }
-
- if(my_shape.y > stage.stageHeight)
- {
- my_shape.y = 0;
- }
- else if (my_shape.y < 0)
- {
- my_shape.y = stage.stageHeight;
- }
-
- }
- </codeblock></example></apiValueDetail><related-links class="- topic/related-links "><link href="flash.display.xml#DisplayObject/cacheAsBitmap" class="- topic/link "><linktext class="- topic/linktext ">cacheAsBitmap</linktext></link><link href="flash.geom.xml#Matrix3D" class="- topic/link "><linktext class="- topic/linktext ">flash.geom.Matrix3D</linktext></link></related-links></apiValue><apiValue id="flash.display:DisplayObject:cacheAsBitmap:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">cacheAsBitmap</apiName><shortdesc class="- topic/shortdesc ">
- If set to true, Flash runtimes cache an internal bitmap representation of the
- display object.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Boolean</apiValueClassifier><apiTipTexts><apiTipText class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiTipText ">Whether to cache this DisplayObject as a bitmap.
-
- </apiTipText></apiTipTexts></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- If set to <codeph class="+ topic/ph pr-d/codeph ">true</codeph>, Flash runtimes cache an internal bitmap representation of the
- display object. This caching can increase performance for display objects that contain complex
- vector content.
-
- <p class="- topic/p ">All vector data for a display object that has a cached bitmap is drawn to the bitmap
- instead of the main display. If <codeph class="+ topic/ph pr-d/codeph ">cacheAsBitmapMatrix</codeph> is null or unsupported,
- the bitmap is then copied to the main display as unstretched, unrotated pixels snapped to
- the nearest pixel boundaries. Pixels are mapped 1 to 1 with
- the parent object. If the bounds of the bitmap change, the bitmap is recreated instead
- of being stretched.</p>
-
- <p class="- topic/p ">If <codeph class="+ topic/ph pr-d/codeph ">cacheAsBitmapMatrix</codeph> is non-null and supported, the object is drawn to the off-screen bitmap
- using that matrix and the stretched and/or rotated results of that rendering are used
- to draw the object to the main display.</p>
-
- <p class="- topic/p ">No internal bitmap is created unless the <codeph class="+ topic/ph pr-d/codeph ">cacheAsBitmap</codeph> property is set to
- <codeph class="+ topic/ph pr-d/codeph ">true</codeph>.</p>
-
- <p class="- topic/p ">After you set the <codeph class="+ topic/ph pr-d/codeph ">cacheAsBitmap</codeph> property to <codeph class="+ topic/ph pr-d/codeph ">true</codeph>,
- the rendering does not change, however the display object performs pixel snapping
- automatically. The animation speed can be significantly faster depending
- on the complexity of the vector content.
- </p>
-
- <p class="- topic/p ">The <codeph class="+ topic/ph pr-d/codeph ">cacheAsBitmap</codeph> property is automatically set to <codeph class="+ topic/ph pr-d/codeph ">true</codeph>
- whenever you apply a filter to a display object (when its <codeph class="+ topic/ph pr-d/codeph ">filter</codeph> array is not empty),
- and if a display object has a filter applied to it, <codeph class="+ topic/ph pr-d/codeph ">cacheAsBitmap</codeph> is reported as
- <codeph class="+ topic/ph pr-d/codeph ">true</codeph> for that display object, even if you set the property to <codeph class="+ topic/ph pr-d/codeph ">false</codeph>.
- If you clear all filters for a display object, the <codeph class="+ topic/ph pr-d/codeph ">cacheAsBitmap</codeph> setting changes to
- what it was last set to.</p>
-
- <p class="- topic/p ">A display object does not use a bitmap even if the <codeph class="+ topic/ph pr-d/codeph ">cacheAsBitmap</codeph>
- property is set to <codeph class="+ topic/ph pr-d/codeph ">true</codeph> and instead renders from vector data in the following cases:</p>
-
- <ul class="- topic/ul "><li class="- topic/li ">The bitmap is too large.
- In AIR 1.5 and Flash Player 10, the maximum size for a bitmap image is 8,191 pixels in width or height,
- and the total number of pixels cannot exceed 16,777,215 pixels. (So, if a bitmap image is 8,191 pixels
- wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier, the limitation is
- is 2880 pixels in height and 2,880 pixels in width.</li><li class="- topic/li ">The bitmap fails to allocate (out of memory error). </li></ul>
-
- <p class="- topic/p ">The <codeph class="+ topic/ph pr-d/codeph ">cacheAsBitmap</codeph> property is best used with movie clips that have
- mostly static content and that do not scale and rotate frequently. With such movie
- clips, <codeph class="+ topic/ph pr-d/codeph ">cacheAsBitmap</codeph> can lead to performance increases when the
- movie clip is translated (when its <i class="+ topic/ph hi-d/i ">x</i> and <i class="+ topic/ph hi-d/i ">y</i> position is changed).</p>
-
- </apiDesc><example conref="examples\DisplayObject.cacheAsBitmap.1.as" class="- topic/example "> The following example applies a drop shadow to a Shape instance.
- It then traces the value of the <codeph class="+ topic/ph pr-d/codeph ">cacheAsBitmap</codeph> property, which is set to
- <codeph class="+ topic/ph pr-d/codeph ">true</codeph> when the filter is applied:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.display.Sprite;
- import flash.filters.DropShadowFilter
- var circle:Sprite = new Sprite();
- circle.graphics.beginFill(0xAA0022);
- circle.graphics.drawCircle(40, 40, 40);
- addChild(circle);
- trace(circle.cacheAsBitmap); // false
- var filter:DropShadowFilter = new DropShadowFilter();
- circle.filters = [filter];
- trace(circle.cacheAsBitmap); // true
- </codeblock></example></apiValueDetail><related-links class="- topic/related-links "><link href="flash.display.xml#DisplayObject/cacheAsBitmapMatrix" class="- topic/link "><linktext class="- topic/linktext ">cacheAsBitmapMatrix</linktext></link><link href="flash.display.xml#DisplayObject/opaqueBackground" class="- topic/link "><linktext class="- topic/linktext ">opaqueBackground</linktext></link></related-links></apiValue><apiValue id="flash.display:DisplayObject:filters:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">filters</apiName><shortdesc class="- topic/shortdesc ">
- An indexed array that contains each filter object currently associated with the display object.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Array</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">When <codeph class="+ topic/ph pr-d/codeph ">filters</codeph> includes a ShaderFilter and the shader
- output type is not compatible with this operation
- (the shader must specify a <codeph class="+ topic/ph pr-d/codeph ">pixel4</codeph>
- output).
-
- </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">When <codeph class="+ topic/ph pr-d/codeph ">filters</codeph> includes a ShaderFilter and the shader
- doesn't specify any image input or the first
- input is not an <codeph class="+ topic/ph pr-d/codeph ">image4</codeph> input.
-
- </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">When <codeph class="+ topic/ph pr-d/codeph ">filters</codeph> includes a ShaderFilter and the shader
- specifies an image input that isn't provided.
-
- </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">When <codeph class="+ topic/ph pr-d/codeph ">filters</codeph> includes a ShaderFilter, a
- ByteArray or Vector.<Number> instance as
- a shader input, and the <codeph class="+ topic/ph pr-d/codeph ">width</codeph>
- and <codeph class="+ topic/ph pr-d/codeph ">height</codeph> properties aren't specified for the
- ShaderInput object, or the specified values don't match the amount of
- data in the input data. See the <codeph class="+ topic/ph pr-d/codeph ">ShaderInput.input</codeph>
- property for more information.
-
- </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- An indexed array that contains each filter object currently associated with the display object.
- The flash.filters package contains several classes that define specific filters you can
- use.
-
- <p class="- topic/p ">Filters can be applied in Flash Professional at design time, or at run time by using
- ActionScript code. To apply a filter by using ActionScript, you must make a temporary copy of the
- entire <codeph class="+ topic/ph pr-d/codeph ">filters</codeph> array, modify the temporary array, then assign the value
- of the temporary array back to the <codeph class="+ topic/ph pr-d/codeph ">filters</codeph> array. You cannot directly
- add a new filter object to the <codeph class="+ topic/ph pr-d/codeph ">filters</codeph> array.</p>
-
- <p class="- topic/p ">To add a filter by using ActionScript, perform the following steps (assume that the
- target display object is named <codeph class="+ topic/ph pr-d/codeph ">myDisplayObject</codeph>):</p>
-
- <ol class="- topic/ol "><li class="- topic/li ">Create a new filter object by using the constructor method of your chosen filter
- class.</li><li class="- topic/li ">Assign the value of the <codeph class="+ topic/ph pr-d/codeph ">myDisplayObject.filters</codeph> array to a temporary array, such
- as one named <codeph class="+ topic/ph pr-d/codeph ">myFilters</codeph>.</li><li class="- topic/li ">Add the new filter object to the <codeph class="+ topic/ph pr-d/codeph ">myFilters</codeph> temporary array.</li><li class="- topic/li ">Assign the value of the temporary array to the <codeph class="+ topic/ph pr-d/codeph ">myDisplayObject.filters</codeph> array.</li></ol>
-
- <p class="- topic/p ">If the <codeph class="+ topic/ph pr-d/codeph ">filters</codeph> array is undefined, you do not need to use a temporary array.
- Instead, you can directly assign an array literal that contains one or more filter objects that
- you create. The first example in the Examples section adds a drop shadow filter by using
- code that handles both defined and undefined <codeph class="+ topic/ph pr-d/codeph ">filters</codeph> arrays.</p>
-
- <p class="- topic/p ">To modify an existing filter object,
- you must use the technique of modifying a copy of the <codeph class="+ topic/ph pr-d/codeph ">filters</codeph> array:</p>
-
- <ol class="- topic/ol "><li class="- topic/li ">Assign the value of the <codeph class="+ topic/ph pr-d/codeph ">filters</codeph> array to a temporary array, such as one
- named <codeph class="+ topic/ph pr-d/codeph ">myFilters</codeph>.</li><li class="- topic/li ">Modify the property by using the temporary array, <codeph class="+ topic/ph pr-d/codeph ">myFilters</codeph>. For example,
- to set the quality property of the first filter in the array, you could use the
- following code: <codeph class="+ topic/ph pr-d/codeph ">myFilters[0].quality = 1;</codeph></li><li class="- topic/li ">Assign the value of the temporary array to the <codeph class="+ topic/ph pr-d/codeph ">filters</codeph> array.</li></ol>
-
- <p class="- topic/p ">At load time, if a display object has an associated filter, it is marked to cache itself as a
- transparent bitmap. From this point forward, as long as the display object has a valid filter list,
- the player caches the display object as a bitmap. This source bitmap is used as a source
- image for the filter effects. Each display object usually has two bitmaps: one with the
- original unfiltered source display object and another for the final image after filtering.
- The final image is used when rendering. As long as the display object does not
- change, the final image does not need updating.</p>
-
- <p class="- topic/p ">The flash.filters package includes classes for filters. For example, to create a DropShadow
- filter, you would write:</p>
-
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.filters.DropShadowFilter
- var myFilter:DropShadowFilter = new DropShadowFilter (distance, angle, color, alpha, blurX, blurY, quality, inner, knockout)
- </codeblock>
-
- <p class="- topic/p ">You can use the <codeph class="+ topic/ph pr-d/codeph ">is</codeph> operator to determine the type of filter assigned to
- each index position in the <codeph class="+ topic/ph pr-d/codeph ">filter</codeph> array. For example, the following code shows
- how to determine the position of the first filter in the <codeph class="+ topic/ph pr-d/codeph ">filters</codeph> array that
- is a DropShadowFilter:
- </p>
-
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.text.TextField;
- import flash.filters.~~;
- var tf:TextField = new TextField();
- var filter1:DropShadowFilter = new DropShadowFilter();
- var filter2:GradientGlowFilter = new GradientGlowFilter();
- tf.filters = [filter1, filter2];
-
- tf.text = "DropShadow index: " + filterPosition(tf, DropShadowFilter).toString(); // 0
- addChild(tf)
-
- function filterPosition(displayObject:DisplayObject, filterClass:Class):int {
- for (var i:uint = 0; i < displayObject.filters.length; i++) {
- if (displayObject.filters[i] is filterClass) {
- return i;
- }
- }
- return -1;
- }
- </codeblock>
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> Since you cannot directly add a new filter object to the
- <codeph class="+ topic/ph pr-d/codeph ">DisplayObject.filters</codeph> array, the following code has no
- effect on the target display object, named <codeph class="+ topic/ph pr-d/codeph ">myDisplayObject</codeph>:</p>
-
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- myDisplayObject.filters.push(myDropShadow);
- </codeblock>
-
- </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="../../flash/filters/package-detail.html" class="- topic/link "><linktext class="- topic/linktext ">flash.filters package</linktext></link><link href="flash.display.xml#ShaderInput/input" class="- topic/link "><linktext class="- topic/linktext ">flash.display.ShaderInput.input</linktext></link></related-links></apiValue><apiValue id="flash.display:DisplayObject:height:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">height</apiName><shortdesc class="- topic/shortdesc ">
- Indicates the height of the display object, in pixels.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Indicates the height of the display object, in pixels. The height is calculated based on the bounds of the content of the display object.
- When you set the <codeph class="+ topic/ph pr-d/codeph ">height</codeph> property, the <codeph class="+ topic/ph pr-d/codeph ">scaleY</codeph> property is adjusted accordingly, as shown in the
- following code:
-
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- var rect:Shape = new Shape();
- rect.graphics.beginFill(0xFF0000);
- rect.graphics.drawRect(0, 0, 100, 100);
- trace(rect.scaleY) // 1;
- rect.height = 200;
- trace(rect.scaleY) // 2;</codeblock>
-
- <p class="- topic/p ">Except for TextField and Video objects, a display object with no content (such as an empty sprite) has a height
- of 0, even if you try to set <codeph class="+ topic/ph pr-d/codeph ">height</codeph> to a different value.</p>
-
- </apiDesc><example conref="examples\DisplayObject.height.1.as" class="- topic/example "> The following code creates two TextField objects and adjusts the
- <codeph class="+ topic/ph pr-d/codeph ">height</codeph> property of each based on the <codeph class="+ topic/ph pr-d/codeph ">textHeight</codeph> property of
- each; it also positions the second text field by setting its <codeph class="+ topic/ph pr-d/codeph ">y</codeph> property:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.text.TextField;
- var tf1:TextField = new TextField();
- tf1.text = "Text Field 1";
- tf1.border = true;
- tf1.wordWrap = true;
- tf1.width = 40;
- tf1.height = tf1.textHeight + 5;
- addChild(tf1);
- var tf2:TextField = new TextField();
- tf2.text = "Text Field 2";
- tf2.border = true;
- tf2.wordWrap = true;
- tf2.width = 40;
- tf2.height = tf2.textHeight + 5;
- tf2.y = tf1.y + tf1.height + 5;
- addChild(tf2);
- </codeblock></example></apiValueDetail></apiValue><apiValue id="flash.display:DisplayObject:loaderInfo:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">loaderInfo</apiName><shortdesc class="- topic/shortdesc ">
- Returns a LoaderInfo object containing information about loading the file
- to which this display object belongs.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.display:LoaderInfo</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Returns a LoaderInfo object containing information about loading the file
- to which this display object belongs. The <codeph class="+ topic/ph pr-d/codeph ">loaderInfo</codeph> property is defined only
- for the root display object of a SWF file or for a loaded Bitmap (not for a Bitmap that is drawn
- with ActionScript). To find the <codeph class="+ topic/ph pr-d/codeph ">loaderInfo</codeph> object associated with the SWF file that contains
- a display object named <codeph class="+ topic/ph pr-d/codeph ">myDisplayObject</codeph>, use <codeph class="+ topic/ph pr-d/codeph ">myDisplayObject.root.loaderInfo</codeph>.
-
- <p class="- topic/p ">A large SWF file can monitor its download by calling
- <codeph class="+ topic/ph pr-d/codeph ">this.root.loaderInfo.addEventListener(Event.COMPLETE, func)</codeph>.</p>
-
- </apiDesc><example conref="examples\DisplayObject.loaderInfo.1.as" class="- topic/example "> The following code assumes that <codeph class="+ topic/ph pr-d/codeph ">this</codeph> refers to
- a display object. The code outputs the URL of the root SWF file for the
- display object:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- trace (this.loaderInfo.url);
-
- </codeblock></example></apiValueDetail><related-links class="- topic/related-links "><link href="flash.display.xml#LoaderInfo" class="- topic/link "><linktext class="- topic/linktext ">LoaderInfo class</linktext></link></related-links></apiValue><apiValue id="flash.display:DisplayObject:mask:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">mask</apiName><shortdesc class="- topic/shortdesc ">
- The calling display object is masked by the specified mask object.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.display:DisplayObject</apiValueClassifier><apiTipTexts><apiTipText class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiTipText ">Sets a mask for the display object.
-
- </apiTipText></apiTipTexts></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- The calling display object is masked by the specified <codeph class="+ topic/ph pr-d/codeph ">mask</codeph> object.
- To ensure that masking works when the Stage is scaled, the <codeph class="+ topic/ph pr-d/codeph ">mask</codeph> display object
- must be in an active part of the display list. The <codeph class="+ topic/ph pr-d/codeph ">mask</codeph> object itself is not drawn.
- Set <codeph class="+ topic/ph pr-d/codeph ">mask</codeph> to <codeph class="+ topic/ph pr-d/codeph ">null</codeph> to remove the mask.
-
- <p class="- topic/p ">To be able to scale a mask object, it must be on the display list. To be able to drag a mask Sprite object
- (by calling its <codeph class="+ topic/ph pr-d/codeph ">startDrag()</codeph> method), it must be on the display list. To call the
- <codeph class="+ topic/ph pr-d/codeph ">startDrag()</codeph> method for a mask sprite based on a <codeph class="+ topic/ph pr-d/codeph ">mouseDown</codeph> event
- being dispatched by the sprite, set the sprite's <codeph class="+ topic/ph pr-d/codeph ">buttonMode</codeph> property to <codeph class="+ topic/ph pr-d/codeph ">true</codeph>.</p>
-
- <p class="- topic/p ">When display objects are cached by setting the <codeph class="+ topic/ph pr-d/codeph ">cacheAsBitmap</codeph> property to
- <codeph class="+ topic/ph pr-d/codeph ">true</codeph> an the <codeph class="+ topic/ph pr-d/codeph ">cacheAsBitmapMatrix</codeph> property to a Matrix object,
- both the mask and the display object being masked must be part of the same cached
- bitmap. Thus, if the display object is cached, then the mask must be a child of the display object.
- If an ancestor of the display object on the display list is cached, then the mask must be a child of
- that ancestor or one of its descendents. If more than one ancestor of the masked object is cached,
- then the mask must be a descendent of the cached container closest to the masked object in the display list.</p>
-
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> A single <codeph class="+ topic/ph pr-d/codeph ">mask</codeph> object cannot be used to mask more than one calling display object.
- When the <codeph class="+ topic/ph pr-d/codeph ">mask</codeph> is assigned to a second display object, it is removed as the mask of the first
- object, and that object's <codeph class="+ topic/ph pr-d/codeph ">mask</codeph> property becomes <codeph class="+ topic/ph pr-d/codeph ">null</codeph>.</p>
-
- </apiDesc><example conref="examples\DisplayObject.mask.1.as" class="- topic/example "> The following code creates a TextField object as well as a Sprite object
- that is set as a mask for the TextField object. When the user clicks the text
- field, the <codeph class="+ topic/ph pr-d/codeph ">drag()</codeph> event listener function calls the <codeph class="+ topic/ph pr-d/codeph ">startDrag()</codeph>
- method of the mask Sprite object:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.text.TextField;
- import flash.display.Sprite;
- import flash.events.MouseEvent;
- var tf:TextField = new TextField();
- tf.text = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, "
- + "sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. "
- tf.selectable = false;
- tf.wordWrap = true;
- tf.width = 150;
- addChild(tf);
- var square:Sprite = new Sprite();
- square.graphics.beginFill(0xFF0000);
- square.graphics.drawRect(0, 0, 40, 40);
- addChild(square);
- tf.mask = square;
- tf.addEventListener(MouseEvent.MOUSE_DOWN, drag);
- tf.addEventListener(MouseEvent.MOUSE_UP, noDrag);
- function drag(event:MouseEvent):void {
- square.startDrag();
- }
- function noDrag(event:MouseEvent):void {
- square.stopDrag();
- }
- </codeblock></example></apiValueDetail></apiValue><apiValue id="flash.display:DisplayObject:mouseX:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">mouseX</apiName><shortdesc class="- topic/shortdesc ">
- Indicates the x coordinate of the mouse or user input device position, in pixels.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Indicates the x coordinate of the mouse or user input device position, in pixels.
-
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note</b>: For a DisplayObject that has been rotated, the returned x coordinate will reflect the
- non-rotated object.</p>
-
- </apiDesc><example conref="examples\DisplayObject.mouseX.1.as" class="- topic/example "> The following code creates a Sprite object and traces the <codeph class="+ topic/ph pr-d/codeph ">mouseX</codeph>
- and <codeph class="+ topic/ph pr-d/codeph ">mouseY</codeph> positions when the user clicks the sprite:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.display.Sprite;
- import flash.events.MouseEvent;
- var square:Sprite = new Sprite();
- square.graphics.beginFill(0xFF0000);
- square.graphics.drawRect(0, 0, 200, 200);
- addChild(square);
- square.addEventListener(MouseEvent.CLICK, traceCoordinates);
- function traceCoordinates(event:MouseEvent):void {
- trace(square.mouseX, square.mouseY);
- }
- </codeblock></example></apiValueDetail></apiValue><apiValue id="flash.display:DisplayObject:mouseY:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">mouseY</apiName><shortdesc class="- topic/shortdesc ">
- Indicates the y coordinate of the mouse or user input device position, in pixels.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Indicates the y coordinate of the mouse or user input device position, in pixels.
-
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note</b>: For a DisplayObject that has been rotated, the returned y coordinate will reflect the
- non-rotated object.</p>
-
- </apiDesc><example conref="examples\DisplayObject.mouseX.1.as" class="- topic/example "> The following code creates a Sprite object and traces the <codeph class="+ topic/ph pr-d/codeph ">mouseX</codeph>
- and <codeph class="+ topic/ph pr-d/codeph ">mouseY</codeph> positions when the user clicks the sprite:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.display.Sprite;
- import flash.events.MouseEvent;
- var square:Sprite = new Sprite();
- square.graphics.beginFill(0xFF0000);
- square.graphics.drawRect(0, 0, 200, 200);
- addChild(square);
- square.addEventListener(MouseEvent.CLICK, traceCoordinates);
- function traceCoordinates(event:MouseEvent):void {
- trace(square.mouseX, square.mouseY);
- }
- </codeblock></example></apiValueDetail></apiValue><apiValue id="flash.display:DisplayObject:name:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">name</apiName><shortdesc class="- topic/shortdesc ">
- Indicates the instance name of the DisplayObject.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">String</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If you are attempting to set this property on an object that was
- placed on the timeline in the Flash authoring tool.
-
- </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException><apiTipTexts><apiTipText class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiTipText ">The name of this DisplayObject.
-
- </apiTipText></apiTipTexts></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Indicates the instance name of the DisplayObject. The object can be identified in
- the child list of its parent display object container by calling the
- <codeph class="+ topic/ph pr-d/codeph ">getChildByName()</codeph> method of the display object container.
-
- </apiDesc><example conref="examples\DisplayObject.name.1.as" class="- topic/example "> The following code creates two Sprite object and traces the
- associated <codeph class="+ topic/ph pr-d/codeph ">name</codeph> property when the user clicks either of the objects:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.display.Sprite;
- import flash.events.MouseEvent;
- var circle1:Sprite = new Sprite();
- circle1.graphics.beginFill(0xFF0000);
- circle1.graphics.drawCircle(40, 40, 40);
- circle1.name = "circle1";
- addChild(circle1);
- circle1.addEventListener(MouseEvent.CLICK, traceName);
- var circle2:Sprite = new Sprite();
- circle2.graphics.beginFill(0x0000FF);
- circle2.graphics.drawCircle(140, 40, 40);
- circle2.name = "circle2";
- addChild(circle2);
- circle2.addEventListener(MouseEvent.CLICK, traceName);
- function traceName(event:MouseEvent):void {
- trace(event.target.name);
- }
- </codeblock></example></apiValueDetail></apiValue><apiValue id="flash.display:DisplayObject:opaqueBackground:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">opaqueBackground</apiName><shortdesc class="- topic/shortdesc ">
- Specifies whether the display object is opaque with a certain background color.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Object</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Specifies whether the display object is opaque with a certain background color.
- A transparent bitmap contains alpha
- channel data and is drawn transparently. An opaque bitmap has no alpha channel (and renders faster
- than a transparent bitmap). If the bitmap is opaque, you specify its own background color to use.
-
- <p class="- topic/p ">If set to a number value, the surface is opaque (not transparent) with the RGB background
- color that the number specifies. If set to <codeph class="+ topic/ph pr-d/codeph ">null</codeph> (the default value), the display
- object has a transparent background.</p>
-
- <p class="- topic/p ">The <codeph class="+ topic/ph pr-d/codeph ">opaqueBackground</codeph> property is intended mainly for use with the
- <codeph class="+ topic/ph pr-d/codeph ">cacheAsBitmap</codeph> property, for rendering optimization. For display objects in which the
- <codeph class="+ topic/ph pr-d/codeph ">cacheAsBitmap</codeph> property is set to true, setting <codeph class="+ topic/ph pr-d/codeph ">opaqueBackground</codeph> can
- improve rendering performance.</p>
-
- <p class="- topic/p ">The opaque background region is <i class="+ topic/ph hi-d/i ">not</i> matched when calling the <codeph class="+ topic/ph pr-d/codeph ">hitTestPoint()</codeph>
- method with the <codeph class="+ topic/ph pr-d/codeph ">shapeFlag</codeph> parameter set to <codeph class="+ topic/ph pr-d/codeph ">true</codeph>.</p>
-
- <p class="- topic/p ">The opaque background region does not respond to mouse events.</p>
-
- </apiDesc><example conref="examples\DisplayObject.opaqueBackground.1.as" class="- topic/example "> The following code creates a Shape object with a blue circle
- and sets its <codeph class="+ topic/ph pr-d/codeph ">opaqueBackground</codeph> property to red (0xFF0000):
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.display.Shape;
- var circle:Shape = new Shape();
- circle.graphics.beginFill(0x0000FF);
- circle.graphics.drawCircle(40, 40, 40);
- circle.opaqueBackground = 0xFF0000;
- addChild(circle);
- </codeblock></example></apiValueDetail><related-links class="- topic/related-links "><link href="flash.display.xml#DisplayObject/cacheAsBitmap" class="- topic/link "><linktext class="- topic/linktext ">cacheAsBitmap</linktext></link><link href="flash.display.xml#DisplayObject/hitTestPoint()" class="- topic/link "><linktext class="- topic/linktext ">hitTestPoint()</linktext></link></related-links></apiValue><apiValue id="flash.display:DisplayObject:parent:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">parent</apiName><shortdesc class="- topic/shortdesc ">
- Indicates the DisplayObjectContainer object that contains this display object.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.display:DisplayObjectContainer</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">The parent display object belongs to a security sandbox
- to which you do not have access. You can avoid this situation by having
- the parent movie call the <codeph class="+ topic/ph pr-d/codeph ">Security.allowDomain()</codeph> method.
-
- </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">SecurityError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">SecurityError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Indicates the DisplayObjectContainer object that contains this display object. Use the <codeph class="+ topic/ph pr-d/codeph ">parent</codeph>
- property to specify a relative path to display objects that are above the
- current display object in the display list hierarchy.
-
- <p class="- topic/p ">You can use <codeph class="+ topic/ph pr-d/codeph ">parent</codeph> to move up multiple levels in the display list as in the following:</p>
-
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- this.parent.parent.alpha = 20;
- </codeblock>
-
- </apiDesc><example conref="examples\DisplayObject.parent.1.as" class="- topic/example "> The following code creates three Sprite objects and shows how
- the <codeph class="+ topic/ph pr-d/codeph ">parent</codeph> property reflects the display list hierarchy:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.display.Sprite;
- var sprite1:Sprite = new Sprite();
- sprite1.name = "sprite1";
- var sprite2:Sprite = new Sprite();
- sprite2.name = "sprite2";
- var sprite3:Sprite = new Sprite();
- sprite3.name = "sprite3";
- sprite1.addChild(sprite2);
- sprite2.addChild(sprite3);
- trace(sprite2.parent.name); // sprite1
- trace(sprite3.parent.name); // sprite2
- trace(sprite3.parent.parent.name); // sprite1
- </codeblock></example></apiValueDetail></apiValue><apiValue id="flash.display:DisplayObject:root:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">root</apiName><shortdesc class="- topic/shortdesc ">
- 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.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.display:DisplayObject</apiValueClassifier><apiTipTexts><apiTipText class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiTipText ">Return the root display object for this object.
-
- </apiTipText></apiTipTexts></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- For a display object in a loaded SWF file, the <codeph class="+ topic/ph pr-d/codeph ">root</codeph> property is the
- top-most display object in the portion of the display list's tree structure represented by that SWF file.
- For a Bitmap object representing a loaded image file, the <codeph class="+ topic/ph pr-d/codeph ">root</codeph> property is the Bitmap object
- itself. For the instance of the main class of the first SWF file loaded, the <codeph class="+ topic/ph pr-d/codeph ">root</codeph> property is the
- display object itself. The <codeph class="+ topic/ph pr-d/codeph ">root</codeph> property of the Stage object is the Stage object itself. The <codeph class="+ topic/ph pr-d/codeph ">root</codeph>
- property is set to <codeph class="+ topic/ph pr-d/codeph ">null</codeph> for any display object that has not been added to the display list, unless
- it has been added to a display object container that is off the display list but that is a child of the
- top-most display object in a loaded SWF file.
-
- <p class="- topic/p ">For example, if you create a new Sprite object by calling the <codeph class="+ topic/ph pr-d/codeph ">Sprite()</codeph> constructor method,
- its <codeph class="+ topic/ph pr-d/codeph ">root</codeph> property is <codeph class="+ topic/ph pr-d/codeph ">null</codeph> until you add it to the display list (or to a display
- object container that is off the display list but that is a child of the top-most display object in a SWF file).</p>
-
- <p class="- topic/p ">For a loaded SWF file, even though the Loader object used to load the file may not be on the display list,
- the top-most display object in the SWF file has its <codeph class="+ topic/ph pr-d/codeph ">root</codeph> property set to itself. The Loader object
- does not have its <codeph class="+ topic/ph pr-d/codeph ">root</codeph> property set until it is added as a child of a display object for which the
- <codeph class="+ topic/ph pr-d/codeph ">root</codeph> property is set.</p>
-
- </apiDesc><example conref="examples\DisplayObject.root.1.as" class="- topic/example "> The following code shows the difference between the <codeph class="+ topic/ph pr-d/codeph ">root</codeph>
- property for the Stage object, for a display object (a Loader object) that is not loaded (both before
- and after it has been added to the display list), and for a loaded object (a loaded Bitmap object):
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.display.Loader;
- import flash.net.URLRequest;
- import flash.events.Event;
- trace(stage.root); // [object Stage]
- var ldr:Loader = new Loader();
- trace (ldr.root); // null
- addChild(ldr);
- trace (ldr.root); // [object ...]
- var urlReq:URLRequest = new URLRequest("example.jpg");
- ldr.load(urlReq);
- ldr.contentLoaderInfo.addEventListener(Event.COMPLETE, loaded);
- function loaded(event:Event):void {
- trace(ldr.content.root); // [object Bitmap]
- }
- </codeblock></example></apiValueDetail></apiValue><apiValue id="flash.display:DisplayObject:rotationX:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">rotationX</apiName><shortdesc class="- topic/shortdesc ">
- Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. Values from 0 to 180 represent
- clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or
- subtracted from 360 to obtain a value within the range.
-
- </apiDesc><example conref="examples\RotationExample1.as" class="- topic/example "> In this example, two ellipses rotate using their <codeph class="+ topic/ph pr-d/codeph ">rotationX</codeph> and
- <codeph class="+ topic/ph pr-d/codeph ">rotationY</codeph> properties. The first ellipse's registration point is set
- to its center. It rotates around itself. The second ellipse rotates around
- an external point.
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- package {
- import flash.display.MovieClip;
- import flash.display.Shape;
- import flash.geom.*;
- import flash.display.Graphics;
- import flash.events.TimerEvent;
- import flash.utils.Timer;
- public class RotationExample1 extends MovieClip {
- private var ellipse:Shape = new Shape();
- private var speed:int = 10;
- private var ellipse1:Shape;
- private var ellipse2:Shape;
-
- public function RotationExample1():void {
- ellipse1 = drawEllipse(-50, -40, (this.stage.stageWidth / 2),
- (this.stage.stageHeight / 2));
-
- ellipse2 = drawEllipse(30, 40, (this.stage.stageWidth / 2),
- (this.stage.stageHeight / 2));
- this.addChild(ellipse1);
- this.addChild(ellipse2);
- var t:Timer = new Timer(50);
- t.addEventListener(TimerEvent.TIMER, timerHandler);
- t.start();
- }
- private function drawEllipse(x1, y1, x2, y2):Shape {
-
- var e:Shape = new Shape();
- e.graphics.beginFill(0xFF0000);
- e.graphics.lineStyle(2);
- e.graphics.drawEllipse(x1, y1, 100, 80);
- e.graphics.endFill();
- e.x = x2;
- e.y = y2;
- e.z = 1;
- return e;
- }
- private function timerHandler(event:TimerEvent):void {
- ellipse1.rotationY += speed;
- ellipse1.rotationX -= speed;
- ellipse2.rotationY += speed;
- ellipse2.rotationX -= speed;
- }
- }
- }
- </codeblock></example><example conref="examples\Slider_rotationX.as" class="- topic/example "> The following example shows how you can 3D rotate a Sprite object around its x-axis with Flash Professional, ActionScript 3.0, and Flash Player 10 by setting the object's rotationX property.
- Example provided by
- <xref href="http://actionscriptexamples.com/2009/02/26/rotating-a-sprite-object-around-its-x-axis-in-flash-using-actionscript-30-and-flash-player-10/" scope="_mmexternal" class="- topic/xref ">ActionScriptExamples.com</xref>.
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- //Requires:
- // - Slider control UI component in Flash library.
- // - Publish for Flash Player 10.
- //
-
- [SWF(width="400", height="300")]
-
- import fl.controls.Slider;
- import fl.controls.SliderDirection;
- import fl.events.SliderEvent;
-
- var slider:Slider = new Slider();
- slider.direction = SliderDirection.HORIZONTAL;
- slider.minimum = 0;
- slider.maximum = 360;
- slider.value = 45;
- slider.tickInterval = 45;
- slider.snapInterval = 1;
- slider.liveDragging = true;
- slider.addEventListener(SliderEvent.CHANGE, slider_change);
- slider.move(10, 10);
- addChild(slider);
-
- var spr:Sprite = new Sprite();
- spr.graphics.lineStyle(2, 0xFF0000);
- spr.graphics.drawRect(0, 0, 100, 80);
- spr.x = Math.round((stage.stageWidth - spr.width)/2);
- spr.y = Math.round((stage.stageHeight - spr.height)/2);
- spr.rotationX = 45;
- addChild(spr);
-
- function slider_change(evt:SliderEvent):void {
- spr.rotationX = evt.value;
- }
- </codeblock></example></apiValueDetail></apiValue><apiValue id="flash.display:DisplayObject:rotationY:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">rotationY</apiName><shortdesc class="- topic/shortdesc ">
- Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. Values from 0 to 180 represent
- clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or
- subtracted from 360 to obtain a value within the range.
-
-
- </apiDesc><example conref="examples\RotationExample1.as" class="- topic/example "> In this example, two ellipses rotate using their <codeph class="+ topic/ph pr-d/codeph ">rotationX</codeph> and
- <codeph class="+ topic/ph pr-d/codeph ">rotationY</codeph> properties. The first ellipse's registration point is set
- to its center. It rotates around itself. The second ellipse rotates around
- an external point.
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- package {
- import flash.display.MovieClip;
- import flash.display.Shape;
- import flash.geom.*;
- import flash.display.Graphics;
- import flash.events.TimerEvent;
- import flash.utils.Timer;
- public class RotationExample1 extends MovieClip {
- private var ellipse:Shape = new Shape();
- private var speed:int = 10;
- private var ellipse1:Shape;
- private var ellipse2:Shape;
-
- public function RotationExample1():void {
- ellipse1 = drawEllipse(-50, -40, (this.stage.stageWidth / 2),
- (this.stage.stageHeight / 2));
-
- ellipse2 = drawEllipse(30, 40, (this.stage.stageWidth / 2),
- (this.stage.stageHeight / 2));
- this.addChild(ellipse1);
- this.addChild(ellipse2);
- var t:Timer = new Timer(50);
- t.addEventListener(TimerEvent.TIMER, timerHandler);
- t.start();
- }
- private function drawEllipse(x1, y1, x2, y2):Shape {
-
- var e:Shape = new Shape();
- e.graphics.beginFill(0xFF0000);
- e.graphics.lineStyle(2);
- e.graphics.drawEllipse(x1, y1, 100, 80);
- e.graphics.endFill();
- e.x = x2;
- e.y = y2;
- e.z = 1;
- return e;
- }
- private function timerHandler(event:TimerEvent):void {
- ellipse1.rotationY += speed;
- ellipse1.rotationX -= speed;
- ellipse2.rotationY += speed;
- ellipse2.rotationX -= speed;
- }
- }
- }
- </codeblock></example></apiValueDetail></apiValue><apiValue id="flash.display:DisplayObject:rotationZ:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">rotationZ</apiName><shortdesc class="- topic/shortdesc ">
- Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. Values from 0 to 180 represent
- clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or
- subtracted from 360 to obtain a value within the range.
-
-
- </apiDesc></apiValueDetail></apiValue><apiValue id="flash.display:DisplayObject:rotation:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">rotation</apiName><shortdesc class="- topic/shortdesc ">
- Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. Values from 0 to 180 represent
- clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or
- subtracted from 360 to obtain a value within the range. For example, the statement <codeph class="+ topic/ph pr-d/codeph ">my_video.rotation = 450</codeph> is the
- same as <codeph class="+ topic/ph pr-d/codeph "> my_video.rotation = 90</codeph>.
-
- </apiDesc><example conref="examples\DisplayObject.rotation.1.as" class="- topic/example "> The following code creates a Sprite object and rotates
- the object when the user clicks it:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.display.Sprite;
- import flash.events.MouseEvent;
- var square:Sprite = new Sprite();
- square.graphics.beginFill(0xFFCC00);
- square.graphics.drawRect(-50, -50, 100, 100);
- square.x = 150;
- square.y = 150;
- addChild(square);
- square.addEventListener(MouseEvent.CLICK, rotate);
- function rotate(event:MouseEvent):void {
- square.rotation += 15;
- }
- </codeblock></example></apiValueDetail></apiValue><apiValue id="flash.display:DisplayObject:scale9Grid:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">scale9Grid</apiName><shortdesc class="- topic/shortdesc ">
- The current scaling grid that is in effect.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata><asCustoms class="+ topic/metadata adobe-api-d/asCustoms "><maelexample>The following creates a movie clip that contains a 20-pixel line (which forms a border)
- and a gradient fill. The movie clip scales based on the mouse position, and because of the
- <code>scale9Grid</code> set for the movie clip, the thickness of the 20-pixel line does not
- vary when the clip scales (although the gradient in the movie clip <em>does</em> scale):
-
- <listing version="2.0">
- import flash.geom.Rectangle;
- import flash.geom.Matrix;
-
- this.createEmptyMovieClip("my_mc", this.getNextHighestDepth());
-
- var grid:Rectangle = new Rectangle(20, 20, 260, 260);
- my_mc.scale9Grid = grid ;
-
- my_mc._x = 50;
- my_mc._y = 50;
-
- function onMouseMove()
- {
- my_mc._width = _xmouse;
- my_mc._height = _ymouse;
- }
-
- my_mc.lineStyle(20, 0xff3333, 100);
- var gradient_matrix:Matrix = new Matrix();
- gradient_matrix.createGradientBox(15, 15, Math.PI, 10, 10);
- my_mc.beginGradientFill("radial", [0xffff00, 0x0000ff],
- [100, 100], [0, 0xFF], gradient_matrix,
- "reflect", "RGB", 0.9);
- my_mc.moveTo(0, 0);
- my_mc.lineTo(0, 300);
- my_mc.lineTo(300, 300);
- my_mc.lineTo(300, 0);
- my_mc.lineTo(0, 0);
- my_mc.endFill();
- </listing>
-
- </maelexample></asCustoms></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.geom:Rectangle</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If you pass an invalid argument to the method.
-
- </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- The current scaling grid that is in effect. If set to <codeph class="+ topic/ph pr-d/codeph ">null</codeph>,
- the entire display object is scaled normally when any scale transformation is
- applied.
-
- <p class="- topic/p ">When you define the <codeph class="+ topic/ph pr-d/codeph ">scale9Grid</codeph> property, the display object is divided into a
- grid with nine regions based on the <codeph class="+ topic/ph pr-d/codeph ">scale9Grid</codeph> rectangle, which defines the
- center region of the grid. The eight other regions of the grid are the following areas: </p>
-
- <ul class="- topic/ul "><li class="- topic/li ">The upper-left corner outside of the rectangle</li><li class="- topic/li ">The area above the rectangle </li><li class="- topic/li ">The upper-right corner outside of the rectangle</li><li class="- topic/li ">The area to the left of the rectangle</li><li class="- topic/li ">The area to the right of the rectangle</li><li class="- topic/li ">The lower-left corner outside of the rectangle</li><li class="- topic/li ">The area below the rectangle</li><li class="- topic/li ">The lower-right corner outside of the rectangle</li></ul>
-
- <p class="- topic/p ">You can think of the eight regions outside of the center (defined by the rectangle)
- as being like a picture frame that has special rules applied to it when scaled.</p>
-
- <p class="- topic/p ">When the <codeph class="+ topic/ph pr-d/codeph ">scale9Grid</codeph> property is set and a display object is scaled, all text and
- gradients are scaled normally; however, for other types of objects the following rules apply:</p>
-
- <ul class="- topic/ul "><li class="- topic/li ">Content in the center region is scaled normally. </li><li class="- topic/li ">Content in the corners is not scaled. </li><li class="- topic/li ">Content in the top and bottom regions is scaled horizontally only. Content in the
- left and right regions is scaled vertically only.</li><li class="- topic/li ">All fills (including bitmaps, video, and gradients) are stretched to fit their shapes.</li></ul>
-
- <p class="- topic/p ">If a display object is rotated, all subsequent scaling is normal (and the
- <codeph class="+ topic/ph pr-d/codeph ">scale9Grid</codeph> property is ignored).</p>
-
- <p class="- topic/p ">For example, consider the following display object and a rectangle that is applied as the display
- object's <codeph class="+ topic/ph pr-d/codeph ">scale9Grid</codeph>:</p>
-
- <adobetable class="+ topic/table adobe-d/adobetable "><tgroup cols="2" class="- topic/tgroup "><tbody class="- topic/tbody "><row class="- topic/row "><entry align="center" class="- topic/entry "><adobeimage alt="display object image" href="../../images/scale9Grid-a.jpg" placement="inline" class="+ topic/image adobe-d/adobeimage "/>
- <p class="- topic/p ">The display object.</p></entry><entry align="center" class="- topic/entry "><adobeimage alt="display object scale 9 region" href="../../images/scale9Grid-b.jpg" placement="inline" class="+ topic/image adobe-d/adobeimage "/>
- <p class="- topic/p ">The red rectangle shows the <codeph class="+ topic/ph pr-d/codeph ">scale9Grid</codeph>.</p></entry></row></tbody></tgroup></adobetable>
-
- <p class="- topic/p ">When the display object is scaled or stretched, the objects within the rectangle scale
- normally, but the objects outside of the rectangle scale according to the
- <codeph class="+ topic/ph pr-d/codeph ">scale9Grid</codeph> rules:</p>
-
- <adobetable class="+ topic/table adobe-d/adobetable "><tgroup cols="2" class="- topic/tgroup "><tbody class="- topic/tbody "><row class="- topic/row "><entry class="- topic/entry ">Scaled to 75%:</entry><entry class="- topic/entry "><adobeimage alt="display object at 75%" href="../../images/scale9Grid-c.jpg" placement="inline" class="+ topic/image adobe-d/adobeimage "/></entry></row><row class="- topic/row "><entry class="- topic/entry ">Scaled to 50%:</entry><entry class="- topic/entry "><adobeimage alt="display object at 50%" href="../../images/scale9Grid-d.jpg" placement="inline" class="+ topic/image adobe-d/adobeimage "/></entry></row><row class="- topic/row "><entry class="- topic/entry ">Scaled to 25%:</entry><entry class="- topic/entry "><adobeimage alt="display object at 25%" href="../../images/scale9Grid-e.jpg" placement="inline" class="+ topic/image adobe-d/adobeimage "/></entry></row><row class="- topic/row "><entry class="- topic/entry ">Stretched horizontally 150%: </entry><entry class="- topic/entry "><adobeimage alt="display stretched 150%" href="../../images/scale9Grid-f.jpg" placement="inline" class="+ topic/image adobe-d/adobeimage "/></entry></row></tbody></tgroup></adobetable>
-
- <p class="- topic/p ">A common use for setting <codeph class="+ topic/ph pr-d/codeph ">scale9Grid</codeph> is to set up a display object to be used
- as a component, in which edge regions retain the same width when the component is scaled.</p>
-
- </apiDesc><example conref="examples\DisplayObject.scale9Grid.1.as" class="- topic/example "> The following code creates a Shape object with a rectangle drawn in its
- <codeph class="+ topic/ph pr-d/codeph ">graphics</codeph> property. The rectangle has a 20-pixel-thick line as the border and
- it is filled with a gradient. The timer event calls the <codeph class="+ topic/ph pr-d/codeph ">scale()</codeph> function, which
- scales the Shape object by adjusting the <codeph class="+ topic/ph pr-d/codeph ">scaleX</codeph> and <codeph class="+ topic/ph pr-d/codeph ">scaleY</codeph> properties.
- The <codeph class="+ topic/ph pr-d/codeph ">scale9Grid</codeph> applied to the Shape object prevents the rectangle's border line
- from scaling — only the gradient fill scales:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.display.Shape;
- import flash.display.GradientType;
- import flash.display.SpreadMethod;
- import flash.display.InterpolationMethod;
- import flash.geom.Matrix;
- import flash.geom.Rectangle;
- import flash.utils.Timer;
- import flash.events.TimerEvent;
- var square:Shape = new Shape();
- square.graphics.lineStyle(20, 0xFFCC00);
- var gradientMatrix:Matrix = new Matrix();
- gradientMatrix.createGradientBox(15, 15, Math.PI, 10, 10);
- square.graphics.beginGradientFill(GradientType.RADIAL,
- [0xffff00, 0x0000ff],
- [100, 100],
- [0, 0xFF],
- gradientMatrix,
- SpreadMethod.REFLECT,
- InterpolationMethod.RGB,
- 0.9);
- square.graphics.drawRect(0, 0, 100, 100);
- var grid:Rectangle = new Rectangle(20, 20, 60, 60);
- square.scale9Grid = grid ;
- addChild(square);
- var tim:Timer = new Timer(100);
- tim.start();
- tim.addEventListener(TimerEvent.TIMER, scale);
- var scaleFactor:Number = 1.01;
- function scale(event:TimerEvent):void {
- square.scaleX *= scaleFactor;
- square.scaleY *= scaleFactor;
-
- if (square.scaleX > 2.0) {
- scaleFactor = 0.99;
- }
- if (square.scaleX < 1.0) {
- scaleFactor = 1.01;
- }
- }
- </codeblock></example></apiValueDetail><related-links class="- topic/related-links "><link href="flash.geom.xml#Rectangle" class="- topic/link "><linktext class="- topic/linktext ">flash.geom.Rectangle</linktext></link></related-links></apiValue><apiValue id="flash.display:DisplayObject:scaleX:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">scaleX</apiName><shortdesc class="- topic/shortdesc ">
- Indicates the horizontal scale (percentage) of the object as applied from the registration point.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Indicates the horizontal scale (percentage) of the object as applied from the registration point. The default
- registration point is (0,0). 1.0 equals 100% scale.
-
- <p class="- topic/p ">Scaling the local coordinate system changes the <codeph class="+ topic/ph pr-d/codeph ">x</codeph> and <codeph class="+ topic/ph pr-d/codeph ">y</codeph> property values, which are defined in
- whole pixels. </p>
-
- </apiDesc><example conref="examples\DisplayObject.scaleX.1.as" class="- topic/example "> The following code creates a Sprite object with a rectangle drawn in its
- <codeph class="+ topic/ph pr-d/codeph ">graphics</codeph> property. When the user clicks the sprite, it scales by 10%:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.display.Sprite;
- import flash.events.MouseEvent;
- var square:Sprite = new Sprite();
- square.graphics.beginFill(0xFFCC00);
- square.graphics.drawRect(0, 0, 100, 100);
- addChild(square);
- square.addEventListener(MouseEvent.CLICK, scale);
- function scale(event:MouseEvent):void {
- square.scaleX *= 1.10;
- square.scaleY *= 1.10;
- }
- </codeblock></example></apiValueDetail></apiValue><apiValue id="flash.display:DisplayObject:scaleY:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">scaleY</apiName><shortdesc class="- topic/shortdesc ">
- Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. The
- default registration point is (0,0). 1.0 is 100% scale.
-
- <p class="- topic/p ">Scaling the local coordinate system changes the <codeph class="+ topic/ph pr-d/codeph ">x</codeph> and <codeph class="+ topic/ph pr-d/codeph ">y</codeph> property values, which are defined in
- whole pixels. </p>
-
- </apiDesc><example conref="examples\DisplayObject.scaleX.1.as" class="- topic/example "> The following code creates a Sprite object with a rectangle drawn in its
- <codeph class="+ topic/ph pr-d/codeph ">graphics</codeph> property. When the user clicks the sprite, it scales by 10%:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.display.Sprite;
- import flash.events.MouseEvent;
- var square:Sprite = new Sprite();
- square.graphics.beginFill(0xFFCC00);
- square.graphics.drawRect(0, 0, 100, 100);
- addChild(square);
- square.addEventListener(MouseEvent.CLICK, scale);
- function scale(event:MouseEvent):void {
- square.scaleX *= 1.10;
- square.scaleY *= 1.10;
- }
- </codeblock></example></apiValueDetail></apiValue><apiValue id="flash.display:DisplayObject:scaleZ:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">scaleZ</apiName><shortdesc class="- topic/shortdesc ">
- Indicates the depth scale (percentage) of an object as applied from the registration point of the object.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Indicates the depth scale (percentage) of an object as applied from the registration point of the object. The
- default registration point is (0,0). 1.0 is 100% scale.
-
- <p class="- topic/p ">Scaling the local coordinate system changes the <codeph class="+ topic/ph pr-d/codeph ">x</codeph>, <codeph class="+ topic/ph pr-d/codeph ">y</codeph> and <codeph class="+ topic/ph pr-d/codeph ">z</codeph> property values, which are defined in
- whole pixels. </p>
-
-
- </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.display.xml#DisplayObject/z" class="- topic/link "><linktext class="- topic/linktext ">z</linktext></link></related-links></apiValue><apiValue id="flash.display:DisplayObject:scrollRect:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">scrollRect</apiName><shortdesc class="- topic/shortdesc ">
- The scroll rectangle bounds of the display object.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.geom:Rectangle</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- The scroll rectangle bounds of the display object. The display object is cropped to the size
- defined by the rectangle, and it scrolls within the rectangle when you change the
- <codeph class="+ topic/ph pr-d/codeph ">x</codeph> and <codeph class="+ topic/ph pr-d/codeph ">y</codeph> properties of the <codeph class="+ topic/ph pr-d/codeph ">scrollRect</codeph> object.
-
- <p class="- topic/p ">The properties of the <codeph class="+ topic/ph pr-d/codeph ">scrollRect</codeph> Rectangle object use the display object's coordinate space
- and are scaled just like the overall display object. The corner bounds of the cropped window on the scrolling
- display object are the origin of the display object (0,0) and the point defined by the
- width and height of the rectangle. They are not centered around the origin, but
- use the origin to define the upper-left corner of the area. A scrolled display object always
- scrolls in whole pixel increments. </p>
-
- <p class="- topic/p ">You can scroll an object left and right by setting the <codeph class="+ topic/ph pr-d/codeph ">x</codeph> property of the
- <codeph class="+ topic/ph pr-d/codeph ">scrollRect</codeph> Rectangle object. You can scroll an object up and down by setting
- the <codeph class="+ topic/ph pr-d/codeph ">y</codeph> property of the <codeph class="+ topic/ph pr-d/codeph ">scrollRect</codeph> Rectangle object. If the display object
- is rotated 90° and you scroll it left and right, the display object actually scrolls up and down.</p>
-
- </apiDesc><example conref="examples\DisplayObject.scrollRect.1.as" class="- topic/example "> The following example shows how the <codeph class="+ topic/ph pr-d/codeph ">scrollRect</codeph> property defines the
- scrolling area for a display object, <codeph class="+ topic/ph pr-d/codeph ">circle</codeph>. When you click the <codeph class="+ topic/ph pr-d/codeph ">circle</codeph> object,
- the <codeph class="+ topic/ph pr-d/codeph ">clicked()</codeph> event handler method adjusts the <codeph class="+ topic/ph pr-d/codeph ">y</codeph> property of the
- <codeph class="+ topic/ph pr-d/codeph ">scrollRect</codeph> property of the <codeph class="+ topic/ph pr-d/codeph ">circle</codeph> object, causing the object to scroll down:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.display.Sprite;
- import flash.geom.Rectangle;
- import flash.events.MouseEvent;
- var circle:Sprite = new Sprite();
- circle.graphics.beginFill(0xFFCC00);
- circle.graphics.drawCircle(200, 200, 200);
- circle.scrollRect = new Rectangle(0, 0, 200, 200);
- addChild(circle);
- circle.addEventListener(MouseEvent.CLICK, clicked);
- function clicked(event:MouseEvent):void {
- var rect:Rectangle = event.target.scrollRect;
- rect.y -= 5;
- event.target.scrollRect = rect;
- }
- </codeblock></example></apiValueDetail><related-links class="- topic/related-links "><link href="flash.geom.xml#Rectangle" class="- topic/link "><linktext class="- topic/linktext ">flash.geom.Rectangle</linktext></link></related-links></apiValue><apiValue id="flash.display:DisplayObject:stage:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">stage</apiName><shortdesc class="- topic/shortdesc ">
- The Stage of the display object.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="read" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.display:Stage</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- The Stage of the display object. A Flash runtime application has only one Stage object.
- For example, you can create and load multiple display objects into the display list, and the
- <codeph class="+ topic/ph pr-d/codeph ">stage</codeph> property of each display object refers to the same Stage object (even if the
- display object belongs to a loaded SWF file).
-
- <p class="- topic/p ">If a display object is not added to the display list, its <codeph class="+ topic/ph pr-d/codeph ">stage</codeph> property is set to
- <codeph class="+ topic/ph pr-d/codeph ">null</codeph>.</p>
-
- </apiDesc><example conref="examples\DisplayObject.stage.1.as" class="- topic/example "> The following code creates two TextField objects and uses the
- <codeph class="+ topic/ph pr-d/codeph ">width</codeph> property of the Stage object to position the text fields:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.text.TextField;
- var tf1:TextField = new TextField();
- tf1.text = "Text Field 1";
- tf1.border = true;
- tf1.x = 10;
- addChild(tf1);
- tf1.width = tf1.stage.stageWidth / 2 - 10;
- var tf2:TextField = new TextField();
- tf2.text = "Text Field 2";
- tf2.border = true;
- tf2.x = tf1.x + tf1.width + 5;
- addChild(tf2);
- tf2.width = tf2.stage.stageWidth / 2 - 10;
- trace(stage.stageWidth);
- </codeblock></example></apiValueDetail></apiValue><apiValue id="flash.display:DisplayObject:transform:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">transform</apiName><shortdesc class="- topic/shortdesc ">
- An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.geom:Transform</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
- The specific properties — matrix, colorTransform, and three read-only properties
- (<codeph class="+ topic/ph pr-d/codeph ">concatenatedMatrix</codeph>, <codeph class="+ topic/ph pr-d/codeph ">concatenatedColorTransform</codeph>,
- and <codeph class="+ topic/ph pr-d/codeph ">pixelBounds</codeph>) — are described in the entry for the Transform class.
-
- <p class="- topic/p ">Each of the transform object's properties is itself an object. This concept is important because the only
- way to set new values for the matrix or colorTransform objects is to create a new object and copy that
- object into the transform.matrix or transform.colorTransform property.</p>
-
- <p class="- topic/p ">For example, to increase the <codeph class="+ topic/ph pr-d/codeph ">tx</codeph> value of a display object's matrix, you must make a
- copy of the entire matrix object, then copy the new object into the matrix property of the transform
- object:</p>
-
- <pre xml:space="preserve" class="- topic/pre "><codeph class="+ topic/ph pr-d/codeph ">
- var myMatrix:Matrix = myDisplayObject.transform.matrix;
- myMatrix.tx += 10;
- myDisplayObject.transform.matrix = myMatrix;
- </codeph></pre>
-
- <p class="- topic/p ">You cannot directly set the <codeph class="+ topic/ph pr-d/codeph ">tx</codeph> property. The following code has
- no effect on <codeph class="+ topic/ph pr-d/codeph ">myDisplayObject</codeph>: </p>
-
- <pre xml:space="preserve" class="- topic/pre "><codeph class="+ topic/ph pr-d/codeph ">
- myDisplayObject.transform.matrix.tx += 10;
- </codeph></pre>
-
- <p class="- topic/p ">You can also copy an entire transform object and assign it to another
- display object's transform property. For example, the following code
- copies the entire transform object from <codeph class="+ topic/ph pr-d/codeph ">myOldDisplayObj</codeph> to
- <codeph class="+ topic/ph pr-d/codeph ">myNewDisplayObj</codeph>:</p>
- <codeph class="+ topic/ph pr-d/codeph ">myNewDisplayObj.transform = myOldDisplayObj.transform;</codeph>
- <p class="- topic/p ">The resulting display object, <codeph class="+ topic/ph pr-d/codeph ">myNewDisplayObj</codeph>, now has the same values for its
- matrix, color transform, and pixel bounds as the old display object, <codeph class="+ topic/ph pr-d/codeph ">myOldDisplayObj</codeph>.</p>
-
- <p class="- topic/p ">Note that AIR for TV devices use hardware acceleration, if it is available, for color transforms.</p>
-
- </apiDesc><example conref="examples\DisplayObject.transform.1.as" class="- topic/example "> The following code sets up a <codeph class="+ topic/ph pr-d/codeph ">square</codeph> Sprite object.
- When the user clicks the sprite, the <codeph class="+ topic/ph pr-d/codeph ">transformer()</codeph> method adjusts
- the <codeph class="+ topic/ph pr-d/codeph ">colorTransform</codeph> and <codeph class="+ topic/ph pr-d/codeph ">matrix</codeph> properties of the
- <codeph class="+ topic/ph pr-d/codeph ">transform</codeph> property of the sprite:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.display.Sprite;
- import flash.geom.ColorTransform;
- import flash.geom.Matrix;
- import flash.geom.Transform;
- import flash.events.MouseEvent;
- var square:Sprite = new Sprite();
- square.graphics.lineStyle(20, 0xFF2200);
- square.graphics.beginFill(0x0000DD);
- square.graphics.drawRect(0, 0, 100, 100);
- addChild(square);
- var resultColorTransform:ColorTransform = new ColorTransform();
- resultColorTransform.alphaMultiplier = 0.5;
- resultColorTransform.redOffset = 155;
- resultColorTransform.greenMultiplier = 0.5;
- var skewMatrix:Matrix = new Matrix(1, 1, 0, 1);
- square.addEventListener(MouseEvent.CLICK, transformer);
- function transformer(event:MouseEvent):void {
- var transformation:Transform = square.transform;
- var tempMatrix:Matrix = square.transform.matrix;
- tempMatrix.concat(skewMatrix);
- square.transform.colorTransform = resultColorTransform;
-
- square.transform.matrix = tempMatrix;
- }
- </codeblock></example></apiValueDetail><related-links class="- topic/related-links "><link href="flash.geom.xml#Transform" class="- topic/link "><linktext class="- topic/linktext ">Transform class</linktext></link></related-links></apiValue><apiValue id="flash.display:DisplayObject:visible:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">visible</apiName><shortdesc class="- topic/shortdesc ">
- Whether or not the display object is visible.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Boolean</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Whether or not the display object is visible. Display objects that are not visible
- are disabled. For example, if <codeph class="+ topic/ph pr-d/codeph ">visible=false</codeph> for an InteractiveObject instance,
- it cannot be clicked.
-
- </apiDesc><example conref="examples\DisplayObject.visible.1.as" class="- topic/example "> The following code uses a Timer object to call a function that
- periodically changes the <codeph class="+ topic/ph pr-d/codeph ">visible</codeph> property of a display object,
- resulting in a blinking effect:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.text.TextField;
- import flash.utils.Timer;
- import flash.events.TimerEvent;
- var tf:TextField = new TextField();
- tf.text = "Hello.";
- addChild(tf);
- var tim:Timer = new Timer(250);
- tim.start();
- tim.addEventListener(TimerEvent.TIMER, blinker);
- function blinker(event:TimerEvent):void {
- tf.visible = !tf.visible;
- }
- </codeblock></example></apiValueDetail></apiValue><apiValue id="flash.display:DisplayObject:width:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">width</apiName><shortdesc class="- topic/shortdesc ">
- Indicates the width of the display object, in pixels.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Indicates the width of the display object, in pixels. The width is calculated based on the bounds of the content of the display object.
- When you set the <codeph class="+ topic/ph pr-d/codeph ">width</codeph> property, the <codeph class="+ topic/ph pr-d/codeph ">scaleX</codeph> property is adjusted accordingly, as shown in the
- following code:
-
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- var rect:Shape = new Shape();
- rect.graphics.beginFill(0xFF0000);
- rect.graphics.drawRect(0, 0, 100, 100);
- trace(rect.scaleX) // 1;
- rect.width = 200;
- trace(rect.scaleX) // 2;</codeblock>
-
- <p class="- topic/p ">Except for TextField and Video objects, a display object with no content (such as an empty sprite) has a width
- of 0, even if you try to set <codeph class="+ topic/ph pr-d/codeph ">width</codeph> to a different value.</p>
-
- </apiDesc><example conref="examples\DisplayObject.width.1.as" class="- topic/example "> The following code sets up a <codeph class="+ topic/ph pr-d/codeph ">square</codeph> Sprite object.
- When the user clicks the sprite, the <codeph class="+ topic/ph pr-d/codeph ">widen()</codeph> method increases
- the <codeph class="+ topic/ph pr-d/codeph ">width</codeph> property of the sprite:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.display.Sprite;
- import flash.events.MouseEvent;
- var square:Sprite = new Sprite();
- square.graphics.beginFill(0xFF0000);
- square.graphics.drawRect(0, 0, 100, 100);
- addChild(square);
- square.addEventListener(MouseEvent.CLICK, widen);
- function widen(event:MouseEvent):void {
- square.width += 10;
- }
- </codeblock></example></apiValueDetail></apiValue><apiValue id="flash.display:DisplayObject:x:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">x</apiName><shortdesc class="- topic/shortdesc ">
- Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of
- the parent DisplayObjectContainer.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Indicates the <i class="+ topic/ph hi-d/i ">x</i> coordinate of the DisplayObject instance relative to the local coordinates of
- the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has
- transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer.
- Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's
- children inherit a coordinate system that is rotated 90° counterclockwise.
- The object's coordinates refer to the registration point position.
-
- </apiDesc><example conref="examples\DisplayObject.x.1.as" class="- topic/example "> The following code sets up a <codeph class="+ topic/ph pr-d/codeph ">circle</codeph> Sprite object.
- A Timer object is used to change the <codeph class="+ topic/ph pr-d/codeph ">x</codeph> property of the sprite
- every 50 milliseconds:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.display.Sprite;
- import flash.utils.Timer;
- import flash.events.TimerEvent;
- var circle:Sprite = new Sprite();
- circle.graphics.beginFill(0xFF0000);
- circle.graphics.drawCircle(100, 100, 100);
- addChild(circle);
- var tim:Timer = new Timer(50);
- tim.start();
- tim.addEventListener(TimerEvent.TIMER, bounce);
- var xInc:Number = 2;
- function bounce(event:TimerEvent):void {
- circle.x += xInc;
- if (circle.x > circle.width) {
- xInc = -2;
- }
- if (circle.x < 0) {
- xInc = 2;
- }
- }
- </codeblock></example></apiValueDetail></apiValue><apiValue id="flash.display:DisplayObject:y:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">y</apiName><shortdesc class="- topic/shortdesc ">
- Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of
- the parent DisplayObjectContainer.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Indicates the <i class="+ topic/ph hi-d/i ">y</i> coordinate of the DisplayObject instance relative to the local coordinates of
- the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has
- transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer.
- Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's
- children inherit a coordinate system that is rotated 90° counterclockwise.
- The object's coordinates refer to the registration point position.
-
- </apiDesc><example conref="examples\DisplayObject.height.1.as" class="- topic/example "> The following code creates two TextField objects and adjusts the
- <codeph class="+ topic/ph pr-d/codeph ">height</codeph> property of each based on the <codeph class="+ topic/ph pr-d/codeph ">textHeight</codeph> property of
- each; it also positions the second text field by setting its <codeph class="+ topic/ph pr-d/codeph ">y</codeph> property:
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- import flash.text.TextField;
- var tf1:TextField = new TextField();
- tf1.text = "Text Field 1";
- tf1.border = true;
- tf1.wordWrap = true;
- tf1.width = 40;
- tf1.height = tf1.textHeight + 5;
- addChild(tf1);
- var tf2:TextField = new TextField();
- tf2.text = "Text Field 2";
- tf2.border = true;
- tf2.wordWrap = true;
- tf2.width = 40;
- tf2.height = tf2.textHeight + 5;
- tf2.y = tf1.y + tf1.height + 5;
- addChild(tf2);
- </codeblock></example></apiValueDetail></apiValue><apiValue id="flash.display:DisplayObject:z:get" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">z</apiName><shortdesc class="- topic/shortdesc ">
- Indicates the z coordinate position along the z-axis of the DisplayObject
- instance relative to the 3D parent container.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="readwrite" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">Number</apiValueClassifier></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Indicates the z coordinate position along the z-axis of the DisplayObject
- instance relative to the 3D parent container. The z property is used for
- 3D coordinates, not screen or pixel coordinates.
- <p class="- topic/p ">When you set a <codeph class="+ topic/ph pr-d/codeph ">z</codeph> property for a display object to something other than the default
- value of <codeph class="+ topic/ph pr-d/codeph ">0</codeph>, a corresponding Matrix3D object is automatically created. for adjusting a
- display object's position and orientation
- in three dimensions. When working with the z-axis,
- the existing behavior of x and y properties changes from screen or pixel coordinates to
- positions relative to the 3D parent container.</p>
- <p class="- topic/p ">For example, a child of the <codeph class="+ topic/ph pr-d/codeph ">_root</codeph> at position x = 100, y = 100, z = 200
- is not drawn at pixel location (100,100). The child is drawn wherever the 3D projection
- calculation puts it. The calculation is:</p>
- <p class="- topic/p "><codeph class="+ topic/ph pr-d/codeph "> (x~~cameraFocalLength/cameraRelativeZPosition, y~~cameraFocalLength/cameraRelativeZPosition)</codeph></p>
-
-
- </apiDesc><example conref="examples\ZAxisExample1.as" class="- topic/example "> This example draws two ellipses and has them go back and forth (down and up the
- <codeph class="+ topic/ph pr-d/codeph ">z</codeph> axis) toward the vanishing point. One ellipse is set to move faster
- than the other.
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- package {
- import flash.display.MovieClip;
- import flash.display.Shape;
- import flash.display.Graphics;
- import flash.events.Event;
- import flash.geom.*;
- public class ZAxisExample1 extends MovieClip {
- private var ellipse1Back:int = 1;
- private var ellipse2Back:int = 1;
- private var depth:int = 1000;
-
- public function ZAxisExample1():void {
-
- var ellipse1 = drawEllipse((this.stage.stageWidth / 2) - 100,
- (this.stage.stageHeight / 2), 100, 80, 10);
- var ellipse2 = drawEllipse((this.stage.stageWidth / 2) + 100,
- (this.stage.stageHeight / 2), 100, 80, 300);
- this.addChild(ellipse1);
- this.addChild(ellipse2);
-
- ellipse1.addEventListener(Event.ENTER_FRAME, ellipse1FrameHandler);
- ellipse2.addEventListener(Event.ENTER_FRAME, ellipse2FrameHandler);
- }
- private function drawEllipse(x:Number, y:Number, w:Number, h:Number, z:Number):Shape {
- var s:Shape = new Shape();
- s.z = z;
- s.graphics.beginFill(0xFF0000);
- s.graphics.lineStyle(2);
- s.graphics.drawEllipse(x, y, w, h);
- s.graphics.endFill();
- return s;
- }
- private function ellipse1FrameHandler(e:Event):void {
- ellipse1Back = setDepth(e, ellipse1Back);
- e.currentTarget.z += ellipse1Back * 10;
- }
- private function ellipse2FrameHandler(e:Event):void {
- ellipse2Back = setDepth(e, ellipse2Back);
- e.currentTarget.z += ellipse2Back * 20;
- }
- private function setDepth(e:Event, d:int):int {
- if(e.currentTarget.z > depth) {
- e.currentTarget.z = depth;
- d = -1;
- }else if (e.currentTarget.z < 0) {
- e.currentTarget.z = 0;
- d = 1;
- }
- return d;
- }
- }
- }
- </codeblock></example></apiValueDetail><related-links class="- topic/related-links "><link href="flash.geom.xml#PerspectiveProjection" class="- topic/link "><linktext class="- topic/linktext ">flash.geom.PerspectiveProjection</linktext></link><link href="flash.geom.xml#Matrix3D" class="- topic/link "><linktext class="- topic/linktext ">flash.geom.Matrix3D</linktext></link><link href="flash.display.xml#DisplayObject/transform" class="- topic/link "><linktext class="- topic/linktext ">transform</linktext></link></related-links></apiValue><apiValue id="flash.display:DisplayObject:blendShader:set" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiValue/apiValue "><apiName class="- topic/title reference/title apiRef/apiName ">blendShader</apiName><shortdesc class="- topic/shortdesc ">
- Sets a shader that is used for blending the foreground and background.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="10" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="AIR" version="1.5" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiValueDetail class="- topic/body reference/refbody apiRef/apiDetail apiValue/apiValueDetail "><apiValueDef class="- topic/section reference/section apiRef/apiDef apiValue/apiValueDef "><apiProperty class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiProperty "/><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiDynamic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiDynamic "/><apiValueAccess value="write" class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiValueAccess "/><apiValueClassifier class="- topic/xref reference/xref apiRef/apiRelation apiValue/apiValueClassifier ">flash.display:Shader</apiValueClassifier><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">When the shader output type is not compatible with this operation
- (the shader must specify a <codeph class="+ topic/ph pr-d/codeph ">pixel4</codeph>
- output).
-
- </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">When the shader specifies fewer than two image inputs or the first
- two inputs are not <codeph class="+ topic/ph pr-d/codeph ">image4</codeph> inputs.
-
- </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">When the shader specifies an image input that isn't provided.
-
- </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">When a ByteArray or Vector.<Number> instance is used as
- an input and the <codeph class="+ topic/ph pr-d/codeph ">width</codeph>
- and <codeph class="+ topic/ph pr-d/codeph ">height</codeph> properties aren't specified for the
- ShaderInput, or the specified values don't match the amount of
- data in the input object. See the <codeph class="+ topic/ph pr-d/codeph ">ShaderInput.input</codeph>
- property for more information.
-
- </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException></apiValueDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Sets a shader that is used for blending the foreground and background. When the
- <codeph class="+ topic/ph pr-d/codeph ">blendMode</codeph> property is set to <codeph class="+ topic/ph pr-d/codeph ">BlendMode.SHADER</codeph>, the specified
- Shader is used to create the blend mode output for the display object.
-
- <p class="- topic/p ">Setting the <codeph class="+ topic/ph pr-d/codeph ">blendShader</codeph> property of a display object to a Shader instance
- automatically sets the display object's <codeph class="+ topic/ph pr-d/codeph ">blendMode</codeph> property to
- <codeph class="+ topic/ph pr-d/codeph ">BlendMode.SHADER</codeph>. If the <codeph class="+ topic/ph pr-d/codeph ">blendShader</codeph> property is set (which sets the
- <codeph class="+ topic/ph pr-d/codeph ">blendMode</codeph> property to <codeph class="+ topic/ph pr-d/codeph ">BlendMode.SHADER</codeph>), then the value of the
- <codeph class="+ topic/ph pr-d/codeph ">blendMode</codeph> property is changed, the blend mode can be reset to use the blend
- shader simply by setting the <codeph class="+ topic/ph pr-d/codeph ">blendMode</codeph> property to <codeph class="+ topic/ph pr-d/codeph ">BlendMode.SHADER</codeph>.
- The <codeph class="+ topic/ph pr-d/codeph ">blendShader</codeph> property does not need to be set again except to change the
- shader that's used for the blend mode.</p>
-
- <p class="- topic/p ">The Shader assigned to the <codeph class="+ topic/ph pr-d/codeph ">blendShader</codeph> property must specify at least two
- <codeph class="+ topic/ph pr-d/codeph ">image4</codeph> inputs. The inputs <b class="+ topic/ph hi-d/b ">do not</b> need to be specified in code using the
- associated ShaderInput objects' <codeph class="+ topic/ph pr-d/codeph ">input</codeph> properties. The background display object
- is automatically
- used as the first input (the input with <codeph class="+ topic/ph pr-d/codeph ">index</codeph> 0). The foreground display object
- is used as the second input (the input with <codeph class="+ topic/ph pr-d/codeph ">index</codeph> 1). A shader used as a blend
- shader can specify more than two inputs. In that case, any additional input must be specified
- by setting its ShaderInput instance's <codeph class="+ topic/ph pr-d/codeph ">input</codeph> property.</p>
-
- <p class="- topic/p ">When you assign a Shader instance to this property the shader is copied internally. The
- blend operation uses that internal copy, not a reference to the original shader. Any changes
- made to the shader, such as changing a parameter value, input, or bytecode, are not applied
- to the copied shader that's used for the blend mode.</p>
-
- </apiDesc></apiValueDetail><related-links class="- topic/related-links "><link href="flash.display.xml#BlendMode" class="- topic/link "><linktext class="- topic/linktext ">flash.display.BlendMode</linktext></link><link href="flash.display.xml#Shader" class="- topic/link "><linktext class="- topic/linktext ">flash.display.Shader</linktext></link><link href="flash.display.xml#ShaderInput" class="- topic/link "><linktext class="- topic/linktext ">flash.display.ShaderInput</linktext></link></related-links></apiValue></apiClassifier><apiClassifier languages="" id="flash.display:Loader" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier "><apiName class="- topic/title reference/title apiRef/apiName ">Loader</apiName><shortdesc class="- topic/shortdesc ">
- The Loader class is used to load SWF files or image (JPG, PNG, or GIF) files.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiClassifierDetail class="- topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail "><apiClassifierDef class="- topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiStatic class="+ topic/state reference/state apiRef/apiQualifier adobe-api-d/apiStatic "/><apiBaseClassifier class="- topic/xref reference/xref apiRef/apiRelation apiClassifier/apiBaseClassifier ">flash.display:DisplayObjectContainer</apiBaseClassifier></apiClassifierDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- The Loader class is used to load SWF files or image (JPG, PNG, or GIF) files. Use the
- <codeph class="+ topic/ph pr-d/codeph ">load()</codeph> method to initiate loading. The loaded display object is added as a child
- of the Loader object.
-
- <p class="- topic/p ">Use the URLLoader class to load text or binary data.</p>
-
- <p class="- topic/p ">The Loader class overrides the following methods that it inherits, because a Loader object can only
- have one child display object—the display object that it loads. Calling the following methods throws an
- exception: <codeph class="+ topic/ph pr-d/codeph ">addChild()</codeph>, <codeph class="+ topic/ph pr-d/codeph ">addChildAt()</codeph>, <codeph class="+ topic/ph pr-d/codeph ">removeChild()</codeph>,
- <codeph class="+ topic/ph pr-d/codeph ">removeChildAt()</codeph>, and <codeph class="+ topic/ph pr-d/codeph ">setChildIndex()</codeph>. To remove a loaded display object,
- you must remove the <i class="+ topic/ph hi-d/i ">Loader</i> object from its parent DisplayObjectContainer child array. </p>
-
- <p class="- topic/p "><b class="+ topic/ph hi-d/b ">Note:</b> The ActionScript 2.0 MovieClipLoader and LoadVars classes are not used
- in ActionScript 3.0. The Loader and URLLoader classes replace them.</p>
-
- <p class="- topic/p ">When you use the Loader class, consider the Flash Player and Adobe AIR security model: </p>
-
- <ul class="- topic/ul "><li class="- topic/li ">You can load content from any accessible source. </li><li class="- topic/li ">Loading is not allowed if the calling SWF file is in a network sandbox and the file
- to be loaded is local. </li><li class="- topic/li ">If the loaded content is a SWF file written with ActionScript 3.0, it cannot be
- cross-scripted by a SWF file in another security sandbox unless that cross-scripting
- arrangement was approved through a call to the <codeph class="+ topic/ph pr-d/codeph ">System.allowDomain()</codeph> or
- the <codeph class="+ topic/ph pr-d/codeph ">System.allowInsecureDomain()</codeph> method in the loaded content file.</li><li class="- topic/li ">If the loaded content is an AVM1 SWF file (written using ActionScript 1.0 or 2.0),
- it cannot be cross-scripted by an AVM2 SWF file (written using ActionScript 3.0). However,
- you can communicate between the two SWF files by using the LocalConnection class.</li><li class="- topic/li ">If the loaded content is an image, its data cannot be accessed by a SWF file
- outside of the security sandbox, unless the domain of that SWF file was included in a
- URL policy file at the origin domain of the image.</li><li class="- topic/li ">Movie clips in the local-with-file-system sandbox cannot script movie clips in the
- local-with-networking sandbox, and the reverse is also prevented. </li><li class="- topic/li ">You cannot connect to commonly reserved ports. For a complete list of blocked ports,
- see "Restricting Networking APIs" in the <i class="+ topic/ph hi-d/i ">ActionScript 3.0 Developer's Guide</i>. </li></ul>
-
- <p class="- topic/p ">However, in AIR, content in the <codeph class="+ topic/ph pr-d/codeph ">application</codeph> security sandbox (content
- installed with the AIR application) are not restricted by these security limitations.</p>
-
- <p class="- topic/p ">For more information related to security, see the Flash Player Developer Center Topic:
- <xref href="http://www.adobe.com/go/devnet_security_en" scope="external" class="- topic/xref ">Security</xref>.</p>
-
- <p class="- topic/p ">When loading a SWF file from an untrusted source (such as a domain other than that of
- the Loader object's root SWF file), you may want to define a mask for the Loader object,
- to prevent the loaded content (which is a child of the Loader object) from drawing to
- portions of the Stage outside of that mask, as shown in the following code:</p>
-
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">import flash.display.~~;
- import flash.net.URLRequest;
- var rect:Shape = new Shape();
- rect.graphics.beginFill(0xFFFFFF);
- rect.graphics.drawRect(0, 0, 100, 100);
- rect.graphics.endFill();
- addChild(rect);
- var ldr:Loader = new Loader();
- ldr.mask = rect;
- var url:String = "http://www.unknown.example.com/content.swf";
- var urlReq:URLRequest = new URLRequest(url);
- ldr.load(urlReq);
- addChild(ldr);
- </codeblock>
-
- </apiDesc><example conref="examples\LoaderExample.as" class="- topic/example "> The following example uses the LoaderExample class to illustrate how various
- event listeners are used. This task is accomplished by performing the following steps:
- <ol class="- topic/ol "><li class="- topic/li ">A <codeph class="+ topic/ph pr-d/codeph ">url</codeph> property is created, which is the location and name of the image file</li><li class="- topic/li ">In the <codeph class="+ topic/ph pr-d/codeph ">LoaderExample</codeph> constructor, a new Loader object named <codeph class="+ topic/ph pr-d/codeph ">loader</codeph> is
- created, which is then passed to the <codeph class="+ topic/ph pr-d/codeph ">configureListeners()</codeph> method, described in step 3.</li><li class="- topic/li ">The constructor creates a new instance of a URLRequest object,
- <codeph class="+ topic/ph pr-d/codeph ">request</codeph>, with <codeph class="+ topic/ph pr-d/codeph ">url</codeph> passed so that the file name and location are known.</li><li class="- topic/li ">The <codeph class="+ topic/ph pr-d/codeph ">request</codeph> object is passed to the <codeph class="+ topic/ph pr-d/codeph ">loader</codeph> object's
- <codeph class="+ topic/ph pr-d/codeph ">load()</codeph> method, which loads the image onto the display list.</li><li class="- topic/li ">A <codeph class="+ topic/ph pr-d/codeph ">clickHandler</codeph> event listener is registered for the <codeph class="+ topic/ph pr-d/codeph ">click</codeph> event on the loader.
- After a mouse click, the loaded image is unloaded.</li><li class="- topic/li ">The <codeph class="+ topic/ph pr-d/codeph ">configureListeners()</codeph> method adds seven event listeners by using the following methods:
- <ul class="- topic/ul "><li class="- topic/li ">The <codeph class="+ topic/ph pr-d/codeph ">completeHandler()</codeph> method executes when the image finishes loading.</li><li class="- topic/li ">The <codeph class="+ topic/ph pr-d/codeph ">httpStatusHandler()</codeph> method executes if the image is not loaded
- locally and only if the network request is made available and the Flash Player can detect it.</li><li class="- topic/li ">The <codeph class="+ topic/ph pr-d/codeph ">initHandler()</codeph> method executes before the <codeph class="+ topic/ph pr-d/codeph ">completeHandler()</codeph>
- method and after the <codeph class="+ topic/ph pr-d/codeph ">progressHandler()</codeph> method. Generally, the <codeph class="+ topic/ph pr-d/codeph ">init</codeph>
- event is more useful when loading SWF files.</li><li class="- topic/li ">The <codeph class="+ topic/ph pr-d/codeph ">ioErrorHandler()</codeph> method executes if the image file is not available or not
- accessible.</li><li class="- topic/li ">The <codeph class="+ topic/ph pr-d/codeph ">openHandler()</codeph> method executes when the image file is first opened.</li><li class="- topic/li ">The <codeph class="+ topic/ph pr-d/codeph ">progressHandler()</codeph> method executes when the image file starts to load and
- again when the image is finished loading.</li><li class="- topic/li ">The <codeph class="+ topic/ph pr-d/codeph ">unLoadHandler()</codeph> method executes when the image is unloaded by using the
- <codeph class="+ topic/ph pr-d/codeph ">unload()</codeph> method when the user clicks the image.</li></ul>
- </li></ol>
- <p class="- topic/p "> Keep in mind the following requirements:</p>
-
- <ul class="- topic/ul "><li class="- topic/li ">This example requires that you place a file named Image.gif in the same directory as the compiled SWF file.
- Use an image that has an area that fits within the dimensions of the main SWF file.</li><li class="- topic/li ">Although this example makes use of all events available to the LoaderInfo object, most situations
- require only a subset. In particular, when loading only an image file, the <codeph class="+ topic/ph pr-d/codeph ">complete</codeph> event
- (and perhaps the <codeph class="+ topic/ph pr-d/codeph ">ioError</codeph> event) are sufficient when loading a local image.</li></ul>
-
- <codeblock xml:space="preserve" class="+ topic/pre pr-d/codeblock ">
- package {
- import flash.display.Loader;
- import flash.display.Sprite;
- import flash.events.*;
- import flash.net.URLRequest;
- public class LoaderExample extends Sprite {
- private var url:String = "Image.gif";
- public function LoaderExample() {
- var loader:Loader = new Loader();
- configureListeners(loader.contentLoaderInfo);
- loader.addEventListener(MouseEvent.CLICK, clickHandler);
- var request:URLRequest = new URLRequest(url);
- loader.load(request);
- addChild(loader);
- }
- private function configureListeners(dispatcher:IEventDispatcher):void {
- dispatcher.addEventListener(Event.COMPLETE, completeHandler);
- dispatcher.addEventListener(HTTPStatusEvent.HTTP_STATUS, httpStatusHandler);
- dispatcher.addEventListener(Event.INIT, initHandler);
- dispatcher.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
- dispatcher.addEventListener(Event.OPEN, openHandler);
- dispatcher.addEventListener(ProgressEvent.PROGRESS, progressHandler);
- dispatcher.addEventListener(Event.UNLOAD, unLoadHandler);
- }
- private function completeHandler(event:Event):void {
- trace("completeHandler: " + event);
- }
- private function httpStatusHandler(event:HTTPStatusEvent):void {
- trace("httpStatusHandler: " + event);
- }
- private function initHandler(event:Event):void {
- trace("initHandler: " + event);
- }
- private function ioErrorHandler(event:IOErrorEvent):void {
- trace("ioErrorHandler: " + event);
- }
- private function openHandler(event:Event):void {
- trace("openHandler: " + event);
- }
- private function progressHandler(event:ProgressEvent):void {
- trace("progressHandler: bytesLoaded=" + event.bytesLoaded + " bytesTotal=" + event.bytesTotal);
- }
- private function unLoadHandler(event:Event):void {
- trace("unLoadHandler: " + event);
- }
- private function clickHandler(event:MouseEvent):void {
- trace("clickHandler: " + event);
- var loader:Loader = Loader(event.target);
- loader.unload();
- }
- }
- }
- </codeblock></example></apiClassifierDetail><related-links class="- topic/related-links "><link href="flash.display.xml#LoaderInfo" class="- topic/link "><linktext class="- topic/linktext ">flash.display.LoaderInfo</linktext></link><link href="flash.net.xml#URLLoader" class="- topic/link "><linktext class="- topic/linktext ">flash.net.URLLoader</linktext></link><link href="flash.display.xml#DisplayObject" class="- topic/link "><linktext class="- topic/linktext ">flash.display.DisplayObject</linktext></link></related-links><apiConstructor id="flash.display:Loader:Loader" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation apiOperation/apiConstructor"><apiName class="- topic/title reference/title apiRef/apiName ">Loader</apiName><shortdesc class="- topic/shortdesc ">
- Creates a Loader object that you can use to load files, such as SWF, JPEG, GIF, or PNG files.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata><asCustoms class="+ topic/metadata adobe-api-d/asCustoms "><internal>Need wording on parent/child relationships, root DisplayObjects, and so on.
-
- </internal></asCustoms></prolog><apiConstructorDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail apiOperation/apiConstructorDetail"><apiConstructorDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiConstructorDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/></apiConstructorDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Creates a Loader object that you can use to load files, such as SWF, JPEG, GIF, or PNG files.
- Call the <codeph class="+ topic/ph pr-d/codeph ">load()</codeph> method to load the asset as a child of the Loader instance.
- You can then add the Loader object to the display list (for instance, by using the
- <codeph class="+ topic/ph pr-d/codeph ">addChild()</codeph> method of a DisplayObjectContainer instance).
- The asset appears on the Stage as it loads.
-
- <p class="- topic/p ">You can also use a Loader instance "offlist," that is without adding it to a display object
- container on the display list. In this mode, the Loader instance might be used to load a SWF file
- that contains additional modules of an application. </p>
-
- <p class="- topic/p ">To detect when the SWF file is finished loading, you can use the events of the LoaderInfo
- object associated with the <codeph class="+ topic/ph pr-d/codeph ">contentLoaderInfo</codeph> property of the Loader object.
- At that point, the code in the module SWF file can be executed to initialize and start the module.
- In the offlist mode, a Loader instance might also be used to load a SWF file that contains components or
- media assets. Again, you can use the LoaderInfo object event notifications to detect when the
- components are finished loading. At that point, the application can start using the components
- and media assets in the library of the SWF file by instantiating the ActionScript 3.0 classes that represent
- those components and assets.</p>
-
- <p class="- topic/p ">To determine the status of a Loader object, monitor the following events that the LoaderInfo
- object associated with the <codeph class="+ topic/ph pr-d/codeph ">contentLoaderInfo</codeph> property of the Loader object:</p>
-
- <ul class="- topic/ul "><li class="- topic/li ">The <codeph class="+ topic/ph pr-d/codeph ">open</codeph> event is dispatched when loading begins.</li><li class="- topic/li ">The <codeph class="+ topic/ph pr-d/codeph ">ioError</codeph> or <codeph class="+ topic/ph pr-d/codeph ">securityError</codeph> event is dispatched if the file
- cannot be loaded or if an error occured during the load process. </li><li class="- topic/li ">The <codeph class="+ topic/ph pr-d/codeph ">progress</codeph> event fires continuously while the file is being loaded.</li><li class="- topic/li ">The <codeph class="+ topic/ph pr-d/codeph ">complete</codeph> event is dispatched when a file completes downloading, but before
- the loaded movie clip's methods and properties are available. </li><li class="- topic/li ">The <codeph class="+ topic/ph pr-d/codeph ">init</codeph> event is dispatched after the properties and methods of the loaded SWF file
- are accessible, so you can begin manipulating the loaded SWF file.
- This event is dispatched before the <codeph class="+ topic/ph pr-d/codeph ">complete</codeph> handler. In streaming SWF files,
- the <codeph class="+ topic/ph pr-d/codeph ">init</codeph> event can occur significantly earlier than the <codeph class="+ topic/ph pr-d/codeph ">complete</codeph> event.
- For most purposes, use the <codeph class="+ topic/ph pr-d/codeph ">init</codeph> handler.</li></ul>
-
- </apiDesc></apiConstructorDetail><related-links class="- topic/related-links "><link href="flash.display.xml#Loader/load()" class="- topic/link "><linktext class="- topic/linktext ">flash.display.Loader.load()</linktext></link><link href="flash.display.xml#LoaderInfo" class="- topic/link "><linktext class="- topic/linktext ">flash.display.LoaderInfo</linktext></link></related-links></apiConstructor><apiOperation id="flash.display:Loader:close" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">close</apiName><shortdesc class="- topic/shortdesc ">
- Cancels a load() method operation that is currently in progress for the Loader instance.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiType value="void" name="type" class="- topic/state reference/state apiRef/apiType "/></apiReturn></apiOperationDef><apiDesc class="- topic/section reference/section apiRef/apiDesc ">
- Cancels a <codeph class="+ topic/ph pr-d/codeph ">load()</codeph> method operation that is currently in progress for the Loader instance.
-
- </apiDesc></apiOperationDetail><related-links class="- topic/related-links "><link href="flash.display.xml#Loader/load()" class="- topic/link "><linktext class="- topic/linktext ">flash.display.Loader.load()</linktext></link></related-links></apiOperation><apiOperation id="flash.display:Loader:loadBytes" ditaarch:DITAArchVersion="1.0" domains="(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic pr-d api-d)" class="- topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation "><apiName class="- topic/title reference/title apiRef/apiName ">loadBytes</apiName><shortdesc class="- topic/shortdesc ">
- Loads from binary data stored in a ByteArray object.</shortdesc><prolog class="- topic/prolog "><asMetadata class="+ topic/metadata adobe-api-d/asMetadata "><apiVersion class="+ topic/ph adobe-api-d/apiVersion "><apiLanguage version="3.0" class="+ topic/ph adobe-api-d/apiLanguage "/><apiPlatform description="" name="Flash" version="9" class="+ topic/ph adobe-api-d/apiPlatform "/><apiPlatform description="" name="Lite" version="4" class="+ topic/ph adobe-api-d/apiPlatform "/></apiVersion></asMetadata></prolog><apiOperationDetail class="- topic/body reference/refbody apiRef/apiDetail apiOperation/apiOperationDetail "><apiOperationDef class="- topic/section reference/section apiRef/apiDef apiOperation/apiOperationDef "><apiAccess value="public" class="- topic/state reference/state apiRef/apiQualifier adobe-api-d/apiAccess "/><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If the <codeph class="+ topic/ph pr-d/codeph ">length</codeph> property of the ByteArray object is not
- greater than 0.
-
- </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">ArgumentError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">ArgumentError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If the <codeph class="+ topic/ph pr-d/codeph ">checkPolicyFile</codeph> or <codeph class="+ topic/ph pr-d/codeph ">securityDomain</codeph>
- property of the <codeph class="+ topic/ph pr-d/codeph ">context</codeph> parameter are non-null.
-
- </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If the <codeph class="+ topic/ph pr-d/codeph ">requestedContentParent</codeph> property of the <codeph class="+ topic/ph pr-d/codeph ">context</codeph> parameter
- is a <codeph class="+ topic/ph pr-d/codeph ">Loader</codeph>.
-
- </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If the <codeph class="+ topic/ph pr-d/codeph ">LoaderContext.parameters</codeph> parameter is
- set to non-null and has some values which are not Strings.
-
- </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">IllegalOperationError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.errors:IllegalOperationError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">If the provided <codeph class="+ topic/ph pr-d/codeph ">applicationDomain</codeph> property of the
- <codeph class="+ topic/ph pr-d/codeph ">context</codeph> property is from a disallowed domain.
-
- </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">SecurityError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">SecurityError</apiOperationClassifier></apiException><apiException class="+ topic/ph reference/ph apiRef/apiDefItem apiOperation/apiEvent adobe-api-d/apiException "><apiDesc class="- topic/section reference/section apiRef/apiDesc ">You cannot connect to commonly reserved ports.
- For a complete list of blocked ports, see "Restricting Networking APIs" in the
- <i class="+ topic/ph hi-d/i ">ActionScript 3.0 Developer's Guide</i>.
-
- </apiDesc><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">SecurityError</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">SecurityError</apiOperationClassifier></apiException><apiReturn class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiReturn "><apiType value="void" name="type" class="- topic/state reference/state apiRef/apiType "/></apiReturn><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">bytes</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.utils:ByteArray</apiOperationClassifier><apiDesc class="- topic/section reference/section apiRef/apiDesc ">A ByteArray object. The contents of the ByteArray can be
- any of the file formats supported by the Loader class: SWF, GIF, JPEG, or PNG.
-
- </apiDesc></apiParam><apiParam class="- topic/ph reference/ph apiRef/apiDefItem apiOperation/apiParam "><apiItemName class="- topic/keyword reference/keyword apiRef/apiItemName ">context</apiItemName><apiOperationClassifier class="- topic/xref reference/xref apiRef/apiRelation apiOperation/apiOperationClassifier ">flash.system:LoaderContext</apiOperationClassifier><apiData class="- topic/ph reference/ph apiRef/apiData ">null</apiData><apiDesc class="- topic/section reference/section apiRef/apiDesc ">A LoaderContext object. Only the <codeph class="+ topic/ph pr-d/codeph ">applicationDomain</codeph> property
- of the LoaderContext object applies; the <codeph class="+ topic/ph pr-d/codeph ">chec